From 18495d92d6e202aa014c7aebc778b4ee6b0908ac Mon Sep 17 00:00:00 2001 From: Stan Date: Sun, 10 May 2015 08:31:19 -0500 Subject: [PATCH 01/15] Delete SmartThingsMega.cpp Removing SmartThingsMega library code as first step to migrating to ST_Anything SmartThings library --- .../SmartThingsMega/SmartThingsMega.cpp | 452 ------------------ 1 file changed, 452 deletions(-) delete mode 100644 Arduino/libraries/SmartThingsMega/SmartThingsMega.cpp diff --git a/Arduino/libraries/SmartThingsMega/SmartThingsMega.cpp b/Arduino/libraries/SmartThingsMega/SmartThingsMega.cpp deleted file mode 100644 index d7fd66c..0000000 --- a/Arduino/libraries/SmartThingsMega/SmartThingsMega.cpp +++ /dev/null @@ -1,452 +0,0 @@ -//******************************************************************************* -/// @file -/// @brief -/// SmartThingsMega Arduino Library -/// @section License -/// (C) Copyright 2013 Physical Graph -//******************************************************************************* -#include - -//***************************************************************************** -void SmartThingsMega::debugPrintBuffer(String prefix, uint8_t * pBuf, uint_fast8_t nBuf) -{ - if(_isDebugEnabled) - { - Serial.print(prefix); - for(uint_fast8_t i = 0; i < nBuf; i++) - { - Serial.print(char(pBuf[i])); - } - Serial.println(); - } -} - -//***************************************************************************** -bool SmartThingsMega::isRxLine(uint8_t * pLine) -{ - // line starts with "T00000000:RX" - int validRxLineLength = 12; // TODO: What is a real value for this length? - - // return line.length > validRxLineLength && line[0] == 'T' && line[9] = ':' && line[10] == 'R' && line[11] == 'X'; - return ((pLine[0] == 'T') && (pLine[9] == ':') && (pLine[10] == 'R') && (pLine[11] == 'X')); -} - -//******************************************************************************* -bool SmartThingsMega::isAsciiHex(uint8_t ascii) -{ - bool retVal = false; - if ( - ((ascii >= 'A') && (ascii <= 'F')) || - ((ascii >= 'a') && (ascii <= 'f')) || - ((ascii >= '0') && (ascii <= '9')) - ) - { - retVal = true; - } - return retVal; -} - -//******************************************************************************* -/// @note this function doesn't check for hex validity before converting -//******************************************************************************* -uint8_t SmartThingsMega::asciiToHexU8(uint8_t pAscii[2]) -{ - uint8_t hex; - hex = ((pAscii[0] - (((pAscii[0]>>6) & 0x1) * 0x37)) & 0xF); - hex <<= 4; - hex |= ((pAscii[1] - (((pAscii[1]>>6) & 0x1) * 0x37)) & 0xF); - return hex; -} - -//***************************************************************************** -uint_fast8_t SmartThingsMega::translatePayload(uint8_t *pBuf, uint_fast8_t nBuf, char* payloadString) -{ - uint_fast8_t payloadLength = 0; // return value - uint_fast8_t payloadStart = 0; - uint_fast8_t payloadEnd = 0; - - uint_fast8_t i; - - // find [ ] message from the back of the message - for(i = nBuf-1; i > 0; i--) - { - if(pBuf[i] == ']') - { - payloadEnd = i; - } - else if(pBuf[i] == '[') - { - payloadStart = i; - break; - } - } - - if(_isDebugEnabled) - { - Serial.print("payload start: "); - Serial.print(payloadStart); - Serial.print(" end: "); - Serial.print(payloadEnd); - Serial.print(" : "); - for(i = payloadStart+1; i < payloadEnd; i++) - { - Serial.print(pBuf[i]); - Serial.print(' '); - } - Serial.println(); - } - - // int expectedPayloadLength = (payloadEnd - payloadStart) / 3; // TODO: Verify this, but 2 chars for byte and 1 for space char - // char payloadString[expectedPayloadLength]; - if((payloadStart != 0) && (payloadEnd != 0) && (payloadEnd - payloadStart > 4) && (pBuf[payloadStart+1] == '0') && (pBuf[payloadStart+2] == 'A')) - { // if valid message then parse - i = payloadStart+4; // start+3 should be ' ' - while (i < payloadEnd) - { - if(pBuf[i] != ' ') - { - if(isAsciiHex(pBuf[i]) && isAsciiHex(pBuf[i+1]) ) - { - uint8_t hex = asciiToHexU8(&(pBuf[i])); - payloadString[payloadLength++] = hex; - i++; - } - } - i++; - } - } - - payloadString[payloadLength] = 0x0; // null-terminate the string - return payloadLength; -} - -//***************************************************************************** -void SmartThingsMega::_process(void) -{ - uint32_t nowMilliseconds = millis(); - - if((nowMilliseconds < _lastShieldMS) || ((nowMilliseconds - _lastShieldMS) > 5000)) - { - _shieldGetNetworkInfo(); - _lastShieldMS = nowMilliseconds; - } - else if((_networkState == STATE_JOINED) && - ((nowMilliseconds < _lastPingMS) || ((nowMilliseconds - _lastPingMS) > 60000))) - { // ping every minutes or on rollover - send("ping"); - _lastPingMS = nowMilliseconds; - } - - // check for return character -} - -//***************************************************************************** -void SmartThingsMega::handleLine(void) -{ - if(_nBufRX > 0) - { - if(isRxLine(_pBufRX)) - { - debugPrintBuffer("->| ", _pBufRX, _nBufRX); - { - char messageBuf[255]; // TODO: Figure this out - uint_fast8_t messageBufLength = translatePayload(_pBufRX, _nBufRX, messageBuf); - - if(messageBufLength > 0) - { - debugPrintBuffer("->| payload :: ",(uint8_t *)messageBuf, messageBufLength); - - _calloutFunction(messageBuf); // call out to main application - // that.handleSmartThingMessage(message); - } - else - { - debugPrintBuffer("->| no payload from :: ", _pBufRX, _nBufRX); - } - } - } - else - { //XXX Totally slapped together since this is temp-- will go away with command set change - uint_fast8_t i=0; - bool found = false; - if (_nBufRX >= 32) //netinfo:0022A3000000B675,E30E,02 - { - while (i < _nBufRX) - { - if ( - (_pBufRX[i ] == 'n') && - (_pBufRX[i+1] == 'e') && - (_pBufRX[i+2] == 't') && - (_pBufRX[i+3] == 'i') && - (_pBufRX[i+4] == 'n') && - (_pBufRX[i+5] == 'f') && - (_pBufRX[i+6] == 'o') && - (_pBufRX[i+7] == ':') && - (_pBufRX[i+24] == ',') && - (_pBufRX[i+29] == ',') - ) - { - // parse off EUI - if( - isAsciiHex(_pBufRX[i+8]) && - isAsciiHex(_pBufRX[i+9]) && - isAsciiHex(_pBufRX[i+10]) && - isAsciiHex(_pBufRX[i+11]) && - isAsciiHex(_pBufRX[i+12]) && - isAsciiHex(_pBufRX[i+13]) && - isAsciiHex(_pBufRX[i+14]) && - isAsciiHex(_pBufRX[i+15]) && - isAsciiHex(_pBufRX[i+16]) && - isAsciiHex(_pBufRX[i+17]) && - isAsciiHex(_pBufRX[i+18]) && - isAsciiHex(_pBufRX[i+19]) && - isAsciiHex(_pBufRX[i+20]) && - isAsciiHex(_pBufRX[i+21]) && - isAsciiHex(_pBufRX[i+22]) && - isAsciiHex(_pBufRX[i+23]) && - - isAsciiHex(_pBufRX[i+25]) && - isAsciiHex(_pBufRX[i+26]) && - isAsciiHex(_pBufRX[i+27]) && - isAsciiHex(_pBufRX[i+28]) && - - isAsciiHex(_pBufRX[i+30]) && - isAsciiHex(_pBufRX[i+31]) - ) - { - uint8_t tempNetStat = asciiToHexU8(&(_pBufRX[i+30])); - if (tempNetStat <= STATE_LEAVING) // make sure it maps to the enum - { - _networkState = (SmartThingsNetworkState_t)tempNetStat; - - _nodeID = asciiToHexU8(&(_pBufRX[i+25])); - _nodeID <<= 8; - _nodeID |= asciiToHexU8(&(_pBufRX[i+27])); - - _eui64[7] = asciiToHexU8(&(_pBufRX[i+8 ])); - _eui64[6] = asciiToHexU8(&(_pBufRX[i+10])); - _eui64[5] = asciiToHexU8(&(_pBufRX[i+12])); - _eui64[4] = asciiToHexU8(&(_pBufRX[i+14])); - _eui64[3] = asciiToHexU8(&(_pBufRX[i+16])); - _eui64[2] = asciiToHexU8(&(_pBufRX[i+18])); - _eui64[1] = asciiToHexU8(&(_pBufRX[i+20])); - _eui64[0] = asciiToHexU8(&(_pBufRX[i+22])); - - debugPrintBuffer(" |~> ", &(_pBufRX[i]), 32); - found = true; - } - } - } - i++; - } - } - if (found == false) - debugPrintBuffer("->| IGNORING :: ", _pBufRX, _nBufRX); - } - _nBufRX = 0; - } -} - //***************************************************************************** - void SmartThingsMega::_shieldGetNetworkInfo(void) - { - _prt->print("custom netinfo"); - _prt->print('\n'); - - if(_isDebugEnabled) - { - Serial.print(" |<~ "); - Serial.print("custom netinfo"); - Serial.print('\n'); - } - } - - - //***************************************************************************** - // Thing API | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - // V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V - //***************************************************************************** - SmartThingsMega::SmartThingsMega(HardwareSerial *prt, SmartThingsCallout_t *callout, String shieldType, bool enableDebug) : - _prt(prt), - _calloutFunction(callout), - _isDebugEnabled(enableDebug), - _nBufRX(0), - _lastPingMS(0xFFFFFF00), - _lastShieldMS(0xFFFFFF00), - _networkState(STATE_UNKNOWN) - { - uint_fast8_t i; - - i = shieldType.length(); - if (i > 32) - i = 32; - _shieldTypeLen = i; - - while (i--) - { - _shieldTypeBuf[i] = (uint8_t)shieldType[i]; - } - - _prt->begin(2400); - } - - //***************************************************************************** - //SmartThings::~SmartThings() : ~SoftwareSerial() - SmartThingsMega::~SmartThingsMega() - { - } - - //***************************************************************************** - void SmartThingsMega::run(void) - { - while((_nBufRX < SMARTTHINGS_RX_BUFFER_SIZE) && _prt->available()) - { -#if 0 - _pBufRX[_nBufRX++] = read(); -#else - uint8_t readByte = _prt->read(); - if((readByte == 0x0D) || (readByte == 0x0A)) - { // handle data from SmartThing line-by-line - handleLine(); - } - else - { - // keep track of everything that comes in until we reach a newline - // TODO(cwvh): validate bufferlength 1988-10-19 - //if (_nBufRX > 200) - // panic("too many characters!"); - _pBufRX[_nBufRX++] = readByte; - } -#endif - } - _process(); - } - - //***************************************************************************** - void SmartThingsMega::send(String message) - { - // e.g. thing.print("raw 0x0 {00 00 0A 0A 62 75 74 74 6f 6e 20 64 6f 77 6e }"); - _prt->print("raw 0x0 { 00 00 0A 0A "); - if(_isDebugEnabled) - { - Serial.print("<-| "); - Serial.print("raw 0x0 { 00 00 0A 0A "); - } - - for(int i = 0; i < message.length(); i++) - { - char c = message[i]; - - _prt->print(c, HEX); - _prt->print(' '); - - if(_isDebugEnabled) - { - Serial.print(c, HEX); - Serial.print(' '); - } - } - - _prt->print('}'); - _prt->print('\n'); - if(_isDebugEnabled) - { - Serial.print('}'); - Serial.print('\n'); - } - - _prt->print("send 0x0 1 1"); - _prt->print('\n'); - } - - //***************************************************************************** - void SmartThingsMega::shieldSetLED(uint8_t red, uint8_t green, uint8_t blue) - { - if (red > 9) red = 9; - if (green > 9) green = 9; - if (blue > 9) blue = 9; - - _prt->print("custom rgb "); - _prt->write( (red+'0') ); - _prt->print(' '); - _prt->write( (green+'0') ); - _prt->print(' '); - _prt->write( (blue+'0') ); - _prt->print(' '); - _prt->print('\n'); - - if(_isDebugEnabled) - { - Serial.print(" |<~ "); - Serial.print("custom rgb "); - Serial.write(red+'0'); - Serial.print(' '); - Serial.write(green+'0'); - Serial.print(' '); - Serial.write(blue+'0'); - Serial.print(' '); - Serial.print('\n'); - } - } - - - //***************************************************************************** - SmartThingsNetworkState_t SmartThingsMega::shieldGetLastNetworkState(void) - { - return _networkState; - } - - //***************************************************************************** - SmartThingsNetworkState_t SmartThingsMega::shieldGetNetworkState(void) - { - _shieldGetNetworkInfo(); - return _networkState; - } - - //***************************************************************************** - uint16_t SmartThingsMega::shieldGetNodeID(void) - { - _shieldGetNetworkInfo(); - return _nodeID; - } - - //***************************************************************************** - void SmartThingsMega::shieldGetEUI64(uint8_t eui[8]) - { - _shieldGetNetworkInfo(); - { - uint_fast8_t i = 7; - do - { - eui[i] = _eui64[i]; - } - while (i--); - } - } - - //***************************************************************************** - void SmartThingsMega::shieldFindNetwork(void) - { - _prt->print("custom find"); - _prt->print('\n'); - - if(_isDebugEnabled) - { - Serial.print(" |<~ "); - Serial.print("custom find"); - Serial.print('\n'); - } - } - - //***************************************************************************** - void SmartThingsMega::shieldLeaveNetwork(void) - { - _prt->print("custom leave"); - _prt->print('\n'); - - if(_isDebugEnabled) - { - Serial.print(" |<~ "); - Serial.print("custom leave"); - Serial.print('\n'); - } - } From a0f6bf799668a7e146e1d9acf56397e435284550 Mon Sep 17 00:00:00 2001 From: Stan Date: Sun, 10 May 2015 08:31:34 -0500 Subject: [PATCH 02/15] Delete SmartThingsMega.h Removing SmartThingsMega library code as first step to migrating to ST_Anything SmartThings library --- .../SmartThingsMega/SmartThingsMega.h | 151 ------------------ 1 file changed, 151 deletions(-) delete mode 100644 Arduino/libraries/SmartThingsMega/SmartThingsMega.h diff --git a/Arduino/libraries/SmartThingsMega/SmartThingsMega.h b/Arduino/libraries/SmartThingsMega/SmartThingsMega.h deleted file mode 100644 index bf10a3d..0000000 --- a/Arduino/libraries/SmartThingsMega/SmartThingsMega.h +++ /dev/null @@ -1,151 +0,0 @@ -//******************************************************************************* -/// @file -/// @brief -/// SmartThings Arduino Library -/// @section License -/// (C) Copyright 2013 Physical Graph -//******************************************************************************* -#ifndef __SMARTTHINGS_H__ -#define __SMARTTHINGS_H__ - -#include -#include - -//******************************************************************************* -/// @brief SmartThings Arduino Library Version -//******************************************************************************* -#define SMARTTHINGSLIB_VERSION_MAJOR 0 -#define SMARTTHINGSLIB_VERSION_MINOR 0 -#define SMARTTHINGSLIB_VERSION_BUILD 5 - -#define SMARTTHINGSLIB_VERSION \ - (((SMARTTHINGSLIB_VERSION_MAJOR & 0xFF) << 24) |\ - ((SMARTTHINGSLIB_VERSION_MINOR & 0xFF) << 16) |\ - (SMARTTHINGSLIB_VERSION_BUILD & 0xFFFF)) - -//******************************************************************************* -#define SMARTTHINGS_RX_BUFFER_SIZE 256 // if > 255: change _nBufRX to u16 -#define SMARTTHINGS_SHIELDTYPE_SIZE 32 // if > 255: change _shieldTypeLen to u16 - -//******************************************************************************* -/// @brief Callout Function Definition for Messages Received over ZigBee Network -//******************************************************************************* -typedef void SmartThingsCallout_t(String message); - -//******************************************************************************* -/// @brief ZigBee Network State Definition -//******************************************************************************* -typedef enum -{ - STATE_NO_NETWORK, - STATE_JOINING, - STATE_JOINED, - STATE_JOINED_NOPARENT, - STATE_LEAVING, - STATE_UNKNOWN -} SmartThingsNetworkState_t; - -//******************************************************************************* -// -class SmartThingsMega -{ - private: - HardwareSerial *_prt; - SmartThingsCallout_t *_calloutFunction; - bool _isDebugEnabled; - uint32_t _lastPingMS; - uint32_t _lastShieldMS; - - SmartThingsNetworkState_t _networkState; - uint8_t _eui64[8]; - uint16_t _nodeID; - - uint8_t _shieldTypeBuf[SMARTTHINGS_SHIELDTYPE_SIZE]; - uint8_t _shieldTypeLen; - - uint8_t _pBufRX[SMARTTHINGS_RX_BUFFER_SIZE]; - uint_fast8_t _nBufRX; - - //void debugPrintString(String prefix, String s); - //void debugPrintBuffer(String prefix, byte* b, int len); - - void _shieldGetNetworkInfo(void); - void _process(void); - - void debugPrintBuffer(String prefix, uint8_t * pBuf, uint_fast8_t nBuf); - bool isRxLine(uint8_t * pLine); - bool isAsciiHex(uint8_t ascii); - uint8_t asciiToHexU8(uint8_t pAscii[2]); - uint_fast8_t translatePayload(uint8_t *pBuf, uint_fast8_t nBuf, char* payloadString); - void handleLine(void); - - public: - //******************************************************************************* - /// @brief SmartThings Constructor - /// @param[in] prt - Hardwre serial port - /// @param[in] callout - Set the Callout Function that is called on Msg Reception - /// @param[in] shieldType (optional) - Set the Reported SheildType to the Server - /// @param[in] enableDebug (optional) - Enable internal Library debug - //******************************************************************************* - SmartThingsMega(HardwareSerial *prt, SmartThingsCallout_t *callout, String shieldType="GenericShield", bool enableDebug=false); - - //******************************************************************************* - /// @brief Run SmartThings Library - //******************************************************************************* - void run(void); - - //******************************************************************************* - /// @brief Send Message out over ZigBee to the Hub - /// @param[in] message to send - //******************************************************************************* - void send(String message); - - //******************************************************************************* - /// @brief Set SmartThings Shield MultiColor LED - /// @param[in] red: intensity {0=off to 9=max} - /// @param[in] green: intensity {0=off to 9=max} - /// @param[in] blue: intensity {0=off to 9=max} - //******************************************************************************* - void shieldSetLED(uint8_t red, uint8_t green, uint8_t blue); - - //******************************************************************************* - /// @brief Get Last Read Shield State - /// @return Last Read Network State - //******************************************************************************* - SmartThingsNetworkState_t shieldGetLastNetworkState(void); - - //******************************************************************************* - /// @brief Get Last Read Shield State and Trigger Refresh of Network Info - /// @return Last Read Network State - //******************************************************************************* - SmartThingsNetworkState_t shieldGetNetworkState(void); - - //******************************************************************************* - /// @brief Get Last Read NodeID and Trigger Refresh of Network Info - /// @return Last Read NodeID - //******************************************************************************* - uint16_t shieldGetNodeID(void); - - //******************************************************************************* - /// @brief Get Last Read EUI64 and Trigger Refresh of Network Info - /// @return Last Read EUI64 - //******************************************************************************* - void shieldGetEUI64(uint8_t eui[8]); - - //******************************************************************************* - /// @brief Find and Join a Network - //******************************************************************************* - void shieldFindNetwork(void); - - //******************************************************************************* - /// @brief Leave the Current ZigBee Network - //******************************************************************************* - void shieldLeaveNetwork(void); - - //******************************************************************************* - /// @brief Descructor - //******************************************************************************* - ~SmartThingsMega(); -}; - -#endif From 424e713a358f2324cca3d35a394f95d8b34c4741 Mon Sep 17 00:00:00 2001 From: Stan Date: Sun, 10 May 2015 08:32:08 -0500 Subject: [PATCH 03/15] Delete readme.txt --- Arduino/libraries/readme.txt | 1 - 1 file changed, 1 deletion(-) delete mode 100644 Arduino/libraries/readme.txt diff --git a/Arduino/libraries/readme.txt b/Arduino/libraries/readme.txt deleted file mode 100644 index a8f1390..0000000 --- a/Arduino/libraries/readme.txt +++ /dev/null @@ -1 +0,0 @@ -For information on installing libraries, see: http://arduino.cc/en/Guide/Libraries From 0d910640379358e0d86043fbdd60663b7cb2662a Mon Sep 17 00:00:00 2001 From: d8adrvn Date: Sun, 10 May 2015 10:26:51 -0500 Subject: [PATCH 04/15] Update Arduino sketch to use ST_Anything version of SmartThings library. This requires a hardware reconfiguration to use. Please refer to v3.0 or later README file. --- ...inoMega_Sketch => AD2SmartThings_v3_0.ino} | 25 +- Arduino/libraries/SmartThings/SmartThings.cpp | 677 ++++++ Arduino/libraries/SmartThings/SmartThings.h | 231 +++ Arduino/libraries/SmartThings/docs/Doxyfile | 1809 +++++++++++++++++ .../SmartThings/examples/stLED/stLED.ino | 123 ++ .../stLEDwithNetworkStatus.ino | 164 ++ Arduino/libraries/SmartThings/info.txt | 36 + Arduino/libraries/SmartThings/keywords.txt | 18 + 8 files changed, 3074 insertions(+), 9 deletions(-) rename Arduino/{AD2SmartThings_ArduinoMega_Sketch => AD2SmartThings_v3_0.ino} (86%) create mode 100755 Arduino/libraries/SmartThings/SmartThings.cpp create mode 100755 Arduino/libraries/SmartThings/SmartThings.h create mode 100755 Arduino/libraries/SmartThings/docs/Doxyfile create mode 100755 Arduino/libraries/SmartThings/examples/stLED/stLED.ino create mode 100755 Arduino/libraries/SmartThings/examples/stLEDwithNetworkStatus/stLEDwithNetworkStatus.ino create mode 100755 Arduino/libraries/SmartThings/info.txt create mode 100755 Arduino/libraries/SmartThings/keywords.txt diff --git a/Arduino/AD2SmartThings_ArduinoMega_Sketch b/Arduino/AD2SmartThings_v3_0.ino similarity index 86% rename from Arduino/AD2SmartThings_ArduinoMega_Sketch rename to Arduino/AD2SmartThings_v3_0.ino index bd10974..0341058 100644 --- a/Arduino/AD2SmartThings_ArduinoMega_Sketch +++ b/Arduino/AD2SmartThings_v3_0.ino @@ -1,6 +1,6 @@ /** - * AD2SmartThings v2.0 + * AD2SmartThings v3.0.0 * Couple your Ademco/Honeywell Alarm to your SmartThings Graph using an AD2PI, an Arduino and a ThingShield * The Arduino passes all your alarm messages to your SmartThings Graph where they can be processed by the Device Type * Use the Device Type to control your alarm or use SmartApps to integrate with other events in your home graph @@ -11,8 +11,9 @@ * Timer library was created by Simon Monk as modified by JChristensen https://github.com/JChristensen/Timer. Note: if you * download the library from the source, you must rename the zip file to "Timer" before importing into the Arduino IDE. * - * Arduino Mega Library for SmartThings SmartShield can be found at: - * https://github.com/vassilisv/DSCAlarmSmartThings/tree/master/Arduino/libraries/SmartThingsMega + * An enhanced SmartThings Library was created by Dan G Ogorchock & Daniel J Ogorchock and their version is required for this implementation. + * Their enhanced library can found at: + * https://github.com/DanielOgorchock/ST_Anything/tree/master/Arduino/libraries/SmartThings * * SoftwareSerial library was default library provided with Arduino IDE * @@ -30,23 +31,28 @@ * Pin Configuration for Arduino Mega to ThingSheild * Use standard jumper wires to connect: * Jumper Mega ThingShield - * RX 17 0 - * TX 16 1 + * TX 14 2 + * RX 15 3 + * * * * Credit: thanks to github contributor vassilisv for the intial idea and to AlarmDecoder.com for suggesting to use * serial out feature of the AD2Pi to connect to the Arduino card. This project also benefitted imenseley from code * shared by SmartThings contributor @craig * + * Thanks to Dan G Ogorchock & Daniel J Ogorchock for the updated SmartThings library. This library is required for the ThingShield + * to use the hardware serial port on the Mega and for general performance enhancements. */ -#include //special library for Arduino Mega card +#include +#include //be sure you are using the library from ST_ANYTHING which has support for hardware serial on the Arduino Mega #include +#define PIN_LED 13 + #define BUFFER_SIZE 300 // max message length from ADT - -SmartThingsCallout_t messageCallout; // call out function forward decalaration -SmartThingsMega smartthing(&Serial2, messageCallout); // constructor + +SmartThings smartthing(HW_SERIAL3, messageCallout); //constructor for hardware serial port with ST_Anything Library // set global variables char buffer[BUFFER_SIZE]; //stores characters in AD2Pi to build up a message @@ -198,3 +204,4 @@ void sendUpdate() previousStr=""; } + diff --git a/Arduino/libraries/SmartThings/SmartThings.cpp b/Arduino/libraries/SmartThings/SmartThings.cpp new file mode 100755 index 0000000..814014a --- /dev/null +++ b/Arduino/libraries/SmartThings/SmartThings.cpp @@ -0,0 +1,677 @@ +//******************************************************************************* +/// @file +/// @brief +/// SmartThings Arduino Library +/// @section License +/// (C) Copyright 2013 Physical Graph +/// +/// Updates by Daniel Ogorchock 12/30/2014 - Arduino Mega 2560 HW Serial support +/// -Numerous performance and size optimizations (helpful on UNO with only 2K SRAM) +/// -Arduino UNO should use the SoftwareSerial library Constructor since the UNO has +/// only one Hardware UART port ("Serial") which is used by the USB port for +/// programming and debugging typically. UNO can use the Hardware "Serial" +/// if desired, but USB programming and debug will be troublesome. +/// Leonardo and Mega can use SoftwareSerial BUT cannot use Pin3 for Rx - use +/// Pin10 for Rx and add jumper from Pin10 to Pin3. +/// -Arduino MEGA should use the Hardware Serial Constructor since it has 4 UARTs. +/// "Serial3" port uses pins 14(Tx) and 15(Rx). Wire Pin14 to Pin2 and Pin15 to Pin3. +/// -Be certain to not use Pins 2 & 3 in your Arduino sketch for I/O since they are +/// electrically connected to the ThingShield. +/// -Note - Pin6 is reserved by the ThingShield as well. Best to avoid using it. +/// -The SoftwareSerial library has the following known limitations: +/// - If using multiple software serial ports, only one can receive data at a time. +/// - Not all pins on the Mega and Mega 2560 support change interrupts, so only +/// the following can be used for RX: 10, 11, 12, 13, 14, 15, 50, 51, 52, 53, +/// A8(62), A9(63), A10(64), A11(65), A12(66), A13(67), A14(68), A15(69). +/// - Not all pins on the Leonardo and Micro support change interrupts, so only +/// the following can be used for RX : 8, 9, 10, 11, 14 (MISO), 15 (SCK), 16 (MOSI). +//******************************************************************************* +#include + +//***************************************************************************** +void SmartThings::debugPrintBuffer(String prefix, uint8_t * pBuf, uint_fast8_t nBuf) +{ + if (_isDebugEnabled) + { + Serial.print(prefix); + for (uint_fast8_t i = 0; i < nBuf; i++) + { + Serial.print(char(pBuf[i])); + } + Serial.println(); + } +} + +//***************************************************************************** +bool SmartThings::isRxLine(uint8_t * pLine) +{ + // line starts with "T00000000:RX" + //int validRxLineLength = 12; // TODO: What is a real value for this length? + + // return line.length > validRxLineLength && line[0] == 'T' && line[9] = ':' && line[10] == 'R' && line[11] == 'X'; + return ((pLine[0] == 'T') && (pLine[9] == ':') && (pLine[10] == 'R') && (pLine[11] == 'X')); +} + +//******************************************************************************* +bool SmartThings::isAsciiHex(uint8_t ascii) +{ + bool retVal = false; + if ( + ((ascii >= 'A') && (ascii <= 'F')) || + ((ascii >= 'a') && (ascii <= 'f')) || + ((ascii >= '0') && (ascii <= '9')) + ) + { + retVal = true; + } + return retVal; +} + +//******************************************************************************* +/// @note this function doesn't check for hex validity before converting +//******************************************************************************* +uint8_t SmartThings::asciiToHexU8(uint8_t pAscii[2]) +{ + uint8_t hex; + hex = ((pAscii[0] - (((pAscii[0] >> 6) & 0x1) * 0x37)) & 0xF); + hex <<= 4; + hex |= ((pAscii[1] - (((pAscii[1] >> 6) & 0x1) * 0x37)) & 0xF); + return hex; +} + +//***************************************************************************** +uint_fast8_t SmartThings::translatePayload(uint8_t *pBuf, uint_fast8_t nBuf) +{ + uint_fast8_t payloadLength = 0; // return value + uint_fast8_t payloadStart = 0; + uint_fast8_t payloadEnd = 0; + + uint_fast8_t i; + + // find [ ] message from the back of the message + for (i = nBuf - 1; i > 0; i--) + { + if (pBuf[i] == ']') + { + payloadEnd = i; + } + else if (pBuf[i] == '[') + { + payloadStart = i; + break; + } + } + + + if (_isDebugEnabled) + { + Serial.print(F("payload start: ")); + Serial.print(payloadStart); + Serial.print(F(" end: ")); + Serial.print(payloadEnd); + Serial.print(F(" : ")); + for (i = payloadStart + 1; i < payloadEnd; i++) + { + Serial.print(pBuf[i]); + Serial.print(' '); + } + Serial.println(); + } + + // int expectedPayloadLength = (payloadEnd - payloadStart) / 3; // TODO: Verify this, but 2 chars for byte and 1 for space char + // char payloadString[expectedPayloadLength]; + if ((payloadStart != 0) && (payloadEnd != 0) && (payloadEnd - payloadStart > 4) && (pBuf[payloadStart + 1] == '0') && (pBuf[payloadStart + 2] == 'A')) + { // if valid message then parse + i = payloadStart + 4; // start+3 should be ' ' + while (i < payloadEnd) + { + if (pBuf[i] != ' ') + { + if (isAsciiHex(pBuf[i]) && isAsciiHex(pBuf[i + 1])) + { + pBuf[payloadLength++] = asciiToHexU8(&(pBuf[i++])); + } + } + i++; + } + } + + pBuf[payloadLength] = 0x0; // null-terminate the string + return payloadLength; +} + +//***************************************************************************** +void SmartThings::_process(void) +{ + uint32_t nowMilliseconds = millis(); + + if ((nowMilliseconds < _lastShieldMS) || ((nowMilliseconds - _lastShieldMS) > 5000)) + { + _shieldGetNetworkInfo(); + _lastShieldMS = nowMilliseconds; + } + else if ((_networkState == STATE_JOINED) && + ((nowMilliseconds < _lastPingMS) || ((nowMilliseconds - _lastPingMS) > 60000))) + { // ping every minutes or on rollover + send("ping"); + _lastPingMS = nowMilliseconds; + } + + // check for return character +} + +//***************************************************************************** +void SmartThings::handleLine(void) +{ + if (_nBufRX > 0) + { + if (isRxLine(_pBufRX)) + { + debugPrintBuffer("->| ", _pBufRX, _nBufRX); + { + //char messageBuf[255]; // TODO: Figure this out + uint_fast8_t messageBufLength = translatePayload(_pBufRX, _nBufRX); + + if (messageBufLength > 0) + { + debugPrintBuffer("->| payload :: ", (uint8_t *)_pBufRX, messageBufLength); + + _calloutFunction(String((char *)_pBufRX)); // call out to main application + // that.handleSmartThingMessage(message); + } + else + { + debugPrintBuffer("->| no payload from :: ", _pBufRX, _nBufRX); + } + } + } + else + { //XXX Totally slapped together since this is temp-- will go away with command set change + uint_fast8_t i = 0; + bool found = false; + if (_nBufRX >= 32) //netinfo:0022A3000000B675,E30E,02 + { + while (i < _nBufRX) + { + if ( + (_pBufRX[i] == 'n') && + (_pBufRX[i + 1] == 'e') && + (_pBufRX[i + 2] == 't') && + (_pBufRX[i + 3] == 'i') && + (_pBufRX[i + 4] == 'n') && + (_pBufRX[i + 5] == 'f') && + (_pBufRX[i + 6] == 'o') && + (_pBufRX[i + 7] == ':') && + (_pBufRX[i + 24] == ',') && + (_pBufRX[i + 29] == ',') + ) + { + // parse off EUI + if ( + isAsciiHex(_pBufRX[i + 8]) && + isAsciiHex(_pBufRX[i + 9]) && + isAsciiHex(_pBufRX[i + 10]) && + isAsciiHex(_pBufRX[i + 11]) && + isAsciiHex(_pBufRX[i + 12]) && + isAsciiHex(_pBufRX[i + 13]) && + isAsciiHex(_pBufRX[i + 14]) && + isAsciiHex(_pBufRX[i + 15]) && + isAsciiHex(_pBufRX[i + 16]) && + isAsciiHex(_pBufRX[i + 17]) && + isAsciiHex(_pBufRX[i + 18]) && + isAsciiHex(_pBufRX[i + 19]) && + isAsciiHex(_pBufRX[i + 20]) && + isAsciiHex(_pBufRX[i + 21]) && + isAsciiHex(_pBufRX[i + 22]) && + isAsciiHex(_pBufRX[i + 23]) && + + isAsciiHex(_pBufRX[i + 25]) && + isAsciiHex(_pBufRX[i + 26]) && + isAsciiHex(_pBufRX[i + 27]) && + isAsciiHex(_pBufRX[i + 28]) && + + isAsciiHex(_pBufRX[i + 30]) && + isAsciiHex(_pBufRX[i + 31]) + ) + { + uint8_t tempNetStat = asciiToHexU8(&(_pBufRX[i + 30])); + if (tempNetStat <= STATE_LEAVING) // make sure it maps to the enum + { + _networkState = (SmartThingsNetworkState_t)tempNetStat; + + _nodeID = asciiToHexU8(&(_pBufRX[i + 25])); + _nodeID <<= 8; + _nodeID |= asciiToHexU8(&(_pBufRX[i + 27])); + + _eui64[7] = asciiToHexU8(&(_pBufRX[i + 8])); + _eui64[6] = asciiToHexU8(&(_pBufRX[i + 10])); + _eui64[5] = asciiToHexU8(&(_pBufRX[i + 12])); + _eui64[4] = asciiToHexU8(&(_pBufRX[i + 14])); + _eui64[3] = asciiToHexU8(&(_pBufRX[i + 16])); + _eui64[2] = asciiToHexU8(&(_pBufRX[i + 18])); + _eui64[1] = asciiToHexU8(&(_pBufRX[i + 20])); + _eui64[0] = asciiToHexU8(&(_pBufRX[i + 22])); + + debugPrintBuffer(" |~> ", &(_pBufRX[i]), 32); + found = true; + } + } + } + i++; + } + } + if (found == false) + debugPrintBuffer("->| IGNORING :: ", _pBufRX, _nBufRX); + } + _nBufRX = 0; + } +} +//***************************************************************************** +void SmartThings::_shieldGetNetworkInfo(void) +{ + st_print(F("custom netinfo\n")); + + if (_isDebugEnabled) + { + Serial.print(F(" |<~ custom netinfo\n")); + } +} + +//***************************************************************************** +// Thing API | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** + +// SoftwareSerial Constructor +#ifndef DISABLE_SOFTWARESERIAL +SmartThings::SmartThings(uint8_t pinRX, uint8_t pinTX, SmartThingsCallout_t *callout, String shieldType, bool enableDebug) : + _mySerial(pinRX, pinTX), + _SerialPort(SW_SERIAL), + _calloutFunction(callout), + _isDebugEnabled(enableDebug), + _lastPingMS(0xFFFFFF00), + _lastShieldMS(0xFFFFFF00), + _networkState(STATE_UNKNOWN), + _nBufRX(0) +{ + //Removed for now to save SRAM space - Not sure why ST included this as it is never used in the library + //uint_fast8_t i = shieldType.length(); + //if (i > 32) + // i = 32; + //_shieldTypeLen = i; + + //while (i--) + //{ + // _shieldTypeBuf[i] = (uint8_t)shieldType[i]; + //} + + st_begin(2400); +} +#endif +//Hardware Serial Constructor +SmartThings::SmartThings(SmartThingsSerialType_t hwSerialPort, SmartThingsCallout_t *callout, String shieldType, bool enableDebug) : +#ifndef DISABLE_SOFTWARESERIAL + _mySerial(254, 255), //Needed unless you uncomment the "#define DISABLE_SOFTWARESERIAL" to prevent compiler error (SmartThings.h) +#endif + _SerialPort(hwSerialPort), + _calloutFunction(callout), + _isDebugEnabled(hwSerialPort != HW_SERIAL ? enableDebug : false), //Do not allow debug print statements if using Hardware Serial (pins 0,1) for ST Communications + _lastPingMS(0xFFFFFF00), + _lastShieldMS(0xFFFFFF00), + _networkState(STATE_UNKNOWN), + _nBufRX(0) +{ + //Removed for now to save SRAM space - Not sure why ST included this as it is never used in the library + //uint_fast8_t i = shieldType.length(); + //if (i > 32) + // i = 32; + //_shieldTypeLen = i; + + //while (i--) + //{ + // _shieldTypeBuf[i] = (uint8_t)shieldType[i]; + //} + + st_begin(2400); +} + +//***************************************************************************** +//SmartThings::~SmartThings() +SmartThings::~SmartThings() +{ +} + +//***************************************************************************** +void SmartThings::run(void) +{ + uint8_t readByte; + + while ((_nBufRX < SMARTTHINGS_RX_BUFFER_SIZE) && st_available()) + { + + readByte = st_read(); + + if ((readByte == 0x0D) || (readByte == 0x0A)) + { // handle data from SmartThing Hub line-by-line, execute user's callback function for each line + handleLine(); + } + else + { + // keep track of everything that comes in until we reach a newline + // TODO(cwvh): validate bufferlength 1988-10-19 + //if (_nBufRX > 200) + // panic("too many characters!"); + _pBufRX[_nBufRX++] = readByte; + } + + } + _process(); +} + +//***************************************************************************** +void SmartThings::send(String message) +{ + // e.g. thing.print("raw 0x0 {00 00 0A 0A 62 75 74 74 6f 6e 20 64 6f 77 6e }"); + st_print(F("raw 0x0 { 00 00 0A 0A ")); + + if (_isDebugEnabled) + { + Serial.print(F("<-| raw 0x0 { 00 00 0A 0A ")); + } + + for (int i = 0; i < message.length(); i++) + { + //char c = message[i]; + + st_print(message[i], HEX); + st_print(' '); + + if (_isDebugEnabled) + { + Serial.print(message[i], HEX); + Serial.print(' '); + } + } + + st_print(F("}\nsend 0x0 1 1\n")); + + if (_isDebugEnabled) + { + Serial.print(F("}\nsend 0x0 1 1\n")); + } +} + +//***************************************************************************** +void SmartThings::shieldSetLED(uint8_t red, uint8_t green, uint8_t blue) +{ + if (red > 9) red = 9; + if (green > 9) green = 9; + if (blue > 9) blue = 9; + + st_print(F("custom rgb ")); + st_write((red + '0')); + st_print(' '); + st_write((green + '0')); + st_print(' '); + st_write((blue + '0')); + st_print(F(" \n")); + + if (_isDebugEnabled) + { + Serial.print(F(" |<~ custom rgb ")); + Serial.write(red + '0'); + Serial.print(' '); + Serial.write(green + '0'); + Serial.print(' '); + Serial.write(blue + '0'); + Serial.print(F(" \n")); + } +} + + +//***************************************************************************** +SmartThingsNetworkState_t SmartThings::shieldGetLastNetworkState(void) +{ + return _networkState; +} + +//***************************************************************************** +SmartThingsNetworkState_t SmartThings::shieldGetNetworkState(void) +{ + _shieldGetNetworkInfo(); + return _networkState; +} + +//***************************************************************************** +uint16_t SmartThings::shieldGetNodeID(void) +{ + _shieldGetNetworkInfo(); + return _nodeID; +} + +//***************************************************************************** +void SmartThings::shieldGetEUI64(uint8_t eui[8]) +{ + _shieldGetNetworkInfo(); + { + uint_fast8_t i = 7; + do + { + eui[i] = _eui64[i]; + } while (i--); + } +} + +//***************************************************************************** +void SmartThings::shieldFindNetwork(void) +{ + st_print(F("custom find\n")); + + if (_isDebugEnabled) + { + Serial.print(F(" |<~ custom find\n")); + + } +} + +//***************************************************************************** +void SmartThings::shieldLeaveNetwork(void) +{ + st_print(F("custom leave\n")); + + + if (_isDebugEnabled) + { + Serial.print(F(" |<~ custom leave\n")); + } +} + +//***************************************************************************** +void SmartThings::st_begin(long baudRate) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + _mySerial.begin(baudRate); +#endif + case HW_SERIAL: + Serial.end(); + Serial.begin(baudRate); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + Serial1.end(); + Serial1.begin(baudRate); + break; + case HW_SERIAL2: + Serial2.end(); + Serial2.begin(baudRate); + break; + case HW_SERIAL3: + Serial3.end(); + Serial3.begin(baudRate); + break; +#endif + } +} +//***************************************************************************** +int SmartThings::st_available() +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.available(); +#endif + case HW_SERIAL: + return Serial.available(); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.available(); + break; + case HW_SERIAL2: + return Serial2.available(); + break; + case HW_SERIAL3: + return Serial3.available(); + break; +#endif + default: + return 0; + } +} +//***************************************************************************** +int SmartThings::st_read() +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.read(); +#endif + case HW_SERIAL: + return Serial.read(); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.read(); + break; + case HW_SERIAL2: + return Serial2.read(); + break; + case HW_SERIAL3: + return Serial3.read(); + break; +#endif + default: + return 0; + } +} +//***************************************************************************** +long SmartThings::st_print(String str) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.print(str); +#endif + case HW_SERIAL: + return Serial.print(str); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.print(str); + break; + case HW_SERIAL2: + return Serial2.print(str); + break; + case HW_SERIAL3: + return Serial3.print(str); + break; +#endif + default: + return 0; + } +} + +//***************************************************************************** +long SmartThings::st_print(char c) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.print(c); +#endif + case HW_SERIAL: + return Serial.print(c); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.print(c); + break; + case HW_SERIAL2: + return Serial2.print(c); + break; + case HW_SERIAL3: + return Serial3.print(c); + break; +#endif + default: + return 0; + + } +} + +//***************************************************************************** +long SmartThings::st_print(char c, int i) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.print(c, i); +#endif + case HW_SERIAL: + return Serial.print(c, i); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.print(c, i); + break; + case HW_SERIAL2: + return Serial2.print(c, i); + break; + case HW_SERIAL3: + return Serial3.print(c, i); + break; +#endif + default: + return 0; + } +} + +//***************************************************************************** +byte SmartThings::st_write(uint8_t i) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.write(i); +#endif + case HW_SERIAL: + return Serial.write(i); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.write(i); + break; + case HW_SERIAL2: + return Serial2.write(i); + break; + case HW_SERIAL3: + return Serial3.write(i); + break; +#endif + default: + return 0; + } +} + diff --git a/Arduino/libraries/SmartThings/SmartThings.h b/Arduino/libraries/SmartThings/SmartThings.h new file mode 100755 index 0000000..dcf7513 --- /dev/null +++ b/Arduino/libraries/SmartThings/SmartThings.h @@ -0,0 +1,231 @@ +//******************************************************************************* +/// @file +/// @brief +/// SmartThings Arduino Library +/// @section License +/// (C) Copyright 2013 Physical Graph +/// +/// Updates by Daniel Ogorchock 12/30/2014 - Arduino Mega 2560 HW Serial support +/// -Numerous performance and size optimizations (helpful on UNO with only 2K SRAM) +/// -Arduino UNO should use the SoftwareSerial library Constructor since the UNO has +/// only one Hardware UART port ("Serial") which is used by the USB port for +/// programming and debugging typically. UNO can use the Hardware "Serial" +/// if desired, but USB programming and debug will be troublesome. +/// Leonardo and Mega can use SoftwareSerial BUT cannot use Pin3 for Rx - use +/// Pin10 for Rx and add jumper from Pin10 to Pin3. +/// -Arduino MEGA should use the Hardware Serial Constructor since it has 4 UARTs. +/// "Serial3" port uses pins 14(Tx) and 15(Rx). Wire Pin14 to Pin2 and Pin15 to Pin3. +/// -Be certain to not use Pins 2 & 3 in your Arduino sketch for I/O since they are +/// electrically connected to the ThingShield. +/// -Note - Pin6 is reserved by the ThingShield as well. Best to avoid using it. +/// -The SoftwareSerial library has the following known limitations: +/// - If using multiple software serial ports, only one can receive data at a time. +/// - Not all pins on the Mega and Mega 2560 support change interrupts, so only +/// the following can be used for RX: 10, 11, 12, 13, 14, 15, 50, 51, 52, 53, +/// A8(62), A9(63), A10(64), A11(65), A12(66), A13(67), A14(68), A15(69). +/// - Not all pins on the Leonardo and Micro support change interrupts, so only +/// the following can be used for RX : 8, 9, 10, 11, 14 (MISO), 15 (SCK), 16 (MOSI). +//******************************************************************************* +#ifndef __SMARTTHINGS_H__ +#define __SMARTTHINGS_H__ + +//******************************************************************************* +#define BOARD_TYPE_UNO 0 +#define BOARD_TYPE_LEONARDO 1 +#define BOARD_TYPE_MEGA 2 +//******************************************************************************* + +//#define DISABLE_SOFTWARESERIAL // uncomment to disable SoftwareSerial to save space if using HW Serial + +#include +#include +#ifndef DISABLE_SOFTWARESERIAL +#include +#endif + + +//******************************************************************************* +// Set the correct board type automatically +//******************************************************************************* +#if defined(__AVR_ATmega168__) || defined(__AVR_ATmega328__) || defined(__AVR_ATmega328P__) +#define BOARD_TYPE BOARD_TYPE_UNO +#elif defined(__AVR_ATmega32U4__) +#define BOARD_TYPE BOARD_TYPE_LEONARDO +#elif defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) +#define BOARD_TYPE BOARD_TYPE_MEGA +#else //assume user is using an UNO for the unknown case +#define BOARD_TYPE BOARD_TYPE_UNO +#endif + +//******************************************************************************* + +//******************************************************************************* +/// @brief SmartThings Arduino Library Version +//******************************************************************************* +#define SMARTTHINGSLIB_VERSION_MAJOR 0 +#define SMARTTHINGSLIB_VERSION_MINOR 0 +#define SMARTTHINGSLIB_VERSION_BUILD 6 + +#define SMARTTHINGSLIB_VERSION \ + (((SMARTTHINGSLIB_VERSION_MAJOR & 0xFF) << 24) | \ + ((SMARTTHINGSLIB_VERSION_MINOR & 0xFF) << 16) | \ + (SMARTTHINGSLIB_VERSION_BUILD & 0xFFFF)) + +//******************************************************************************* +#define SMARTTHINGS_RX_BUFFER_SIZE 256 // if > 255: change _nBufRX to u16 +#define SMARTTHINGS_SHIELDTYPE_SIZE 32 // if > 255: change _shieldTypeLen to u16 + +//******************************************************************************* +/// @brief Callout Function Definition for Messages Received over ZigBee Network +//******************************************************************************* +typedef void SmartThingsCallout_t(String message); + +//******************************************************************************* +/// @brief ZigBee Network State Definition +//******************************************************************************* +typedef enum +{ + STATE_NO_NETWORK, + STATE_JOINING, + STATE_JOINED, + STATE_JOINED_NOPARENT, + STATE_LEAVING, + STATE_UNKNOWN +} SmartThingsNetworkState_t; + +//******************************************************************************* +/// @brief Serial Communication Type Definition +//******************************************************************************* +typedef enum +{ + SW_SERIAL, + HW_SERIAL, + HW_SERIAL1, + HW_SERIAL2, + HW_SERIAL3 +} SmartThingsSerialType_t; + +//******************************************************************************* + +class SmartThings +{ +private: +#ifndef DISABLE_SOFTWARESERIAL + SoftwareSerial _mySerial; +#endif + SmartThingsSerialType_t _SerialPort; + SmartThingsCallout_t *_calloutFunction; + bool _isDebugEnabled; + uint32_t _lastPingMS; + uint32_t _lastShieldMS; + + SmartThingsNetworkState_t _networkState; + uint8_t _eui64[8]; + uint16_t _nodeID; + + //Removed for now to save SRAM space - Not sure why ST included this as it is never used in the library + //uint8_t _shieldTypeBuf[SMARTTHINGS_SHIELDTYPE_SIZE]; + //uint8_t _shieldTypeLen; + + uint8_t _pBufRX[SMARTTHINGS_RX_BUFFER_SIZE]; + uint_fast8_t _nBufRX; + + void _shieldGetNetworkInfo(void); + void _process(void); + + void debugPrintBuffer(String prefix, uint8_t * pBuf, uint_fast8_t nBuf); + bool isRxLine(uint8_t * pLine); + bool isAsciiHex(uint8_t ascii); + uint8_t asciiToHexU8(uint8_t pAscii[2]); + uint_fast8_t translatePayload(uint8_t *pBuf, uint_fast8_t nBuf); + void handleLine(void); + void st_begin(long); + int st_available(); + int st_read(); + long st_print(String); + long st_print(char); + long st_print(char, int); + byte st_write(uint8_t); + + +public: + //******************************************************************************* + /// @brief SmartThings SoftwareSerial Constructor + /// @param[in] pinRX - Receive Pin for the SoftwareSerial Port to the Arduino + /// @param[in] pinTX - Transmit Pin for the SoftwareSerial Port to the Arduino + /// @param[in] callout - Set the Callout Function that is called on Msg Reception + /// @param[in] shieldType (optional) - Set the Reported SheildType to the Server + /// @param[in] enableDebug (optional) - Enable internal Library debug + //******************************************************************************* +#ifndef DISABLE_SOFTWARESERIAL + SmartThings(uint8_t pinRX, uint8_t pinTX, SmartThingsCallout_t *callout, String shieldType = "GenericShield", bool enableDebug = false); +#endif + //******************************************************************************* + /// @brief SmartThings HardwareSerial Constructor + /// @param[in] hwSerialPort - enum of Hardware Serial Port to the Arduino + /// @param[in] callout - Set the Callout Function that is called on Msg Reception + /// @param[in] shieldType (optional) - Set the Reported SheildType to the Server + /// @param[in] enableDebug (optional) - Enable internal Library debug + //******************************************************************************* + SmartThings(SmartThingsSerialType_t hwSerialPort, SmartThingsCallout_t *callout, String shieldType = "GenericShield", bool enableDebug = false); + + //******************************************************************************* + /// @brief Descructor + //******************************************************************************* + ~SmartThings(); + + //******************************************************************************* + /// @brief Run SmartThings Library + //******************************************************************************* + void run(void); + + //******************************************************************************* + /// @brief Send Message out over ZigBee to the Hub + /// @param[in] message to send + //******************************************************************************* + void send(String message); + + //******************************************************************************* + /// @brief Set SmartThings Shield MultiColor LED + /// @param[in] red: intensity {0=off to 9=max} + /// @param[in] green: intensity {0=off to 9=max} + /// @param[in] blue: intensity {0=off to 9=max} + //******************************************************************************* + void shieldSetLED(uint8_t red, uint8_t green, uint8_t blue); + + //******************************************************************************* + /// @brief Get Last Read Shield State + /// @return Last Read Network State + //******************************************************************************* + SmartThingsNetworkState_t shieldGetLastNetworkState(void); + + //******************************************************************************* + /// @brief Get Last Read Shield State and Trigger Refresh of Network Info + /// @return Last Read Network State + //******************************************************************************* + SmartThingsNetworkState_t shieldGetNetworkState(void); + + //******************************************************************************* + /// @brief Get Last Read NodeID and Trigger Refresh of Network Info + /// @return Last Read NodeID + //******************************************************************************* + uint16_t shieldGetNodeID(void); + + //******************************************************************************* + /// @brief Get Last Read EUI64 and Trigger Refresh of Network Info + /// @return Last Read EUI64 + //******************************************************************************* + void shieldGetEUI64(uint8_t eui[8]); + + //******************************************************************************* + /// @brief Find and Join a Network + //******************************************************************************* + void shieldFindNetwork(void); + + //******************************************************************************* + /// @brief Leave the Current ZigBee Network + //******************************************************************************* + void shieldLeaveNetwork(void); +}; + +#endif diff --git a/Arduino/libraries/SmartThings/docs/Doxyfile b/Arduino/libraries/SmartThings/docs/Doxyfile new file mode 100755 index 0000000..9fa55a0 --- /dev/null +++ b/Arduino/libraries/SmartThings/docs/Doxyfile @@ -0,0 +1,1809 @@ +tt# Doxyfile 1.8.2 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" "). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = "SmartThings Arduino Shield" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = "\r\n" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "SmartThings Arduino Shield Library Interface" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = "logo.gif" + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = "SmartThings Arduino Shield Interface" + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = YES + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, +# and language is one of the parsers supported by doxygen: IDL, Java, +# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, +# C++. For instance to make doxygen treat .inc files as Fortran files (default +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented classes, +# or namespaces to their corresponding documentation. Such a link can be +# prevented in individual cases by by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +SYMBOL_CACHE_SIZE = 0 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ../ # \ + # indexDoc.txt + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = *.h + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C, C++ and Fortran comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 4 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. + +HTML_DYNAMIC_SECTIONS = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely +# identify the documentation publisher. This should be a reverse domain-name +# style string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = letter + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/Arduino/libraries/SmartThings/examples/stLED/stLED.ino b/Arduino/libraries/SmartThings/examples/stLED/stLED.ino new file mode 100755 index 0000000..3eef3df --- /dev/null +++ b/Arduino/libraries/SmartThings/examples/stLED/stLED.ino @@ -0,0 +1,123 @@ +//***************************************************************************** +/// @file +/// @brief +/// Arduino SmartThings Shield LED Example +/// @note +/// ______________ +/// | | +/// | SW[] | +/// |[]RST | +/// | AREF |-- +/// | GND |-- +/// | 13 |--X LED +/// | 12 |-- +/// | 11 |-- +/// --| 3.3V 10 |-- +/// --| 5V 9 |-- +/// --| GND 8 |-- +/// --| GND | +/// --| Vin 7 |-- +/// | 6 |-- +/// --| A0 5 |-- +/// --| A1 ( ) 4 |-- +/// --| A2 3 |--X THING_RX +/// --| A3 ____ 2 |--X THING_TX +/// --| A4 | | 1 |-- +/// --| A5 | | 0 |-- +/// |____| |____| +/// |____| +/// +//***************************************************************************** +#include //TODO need to set due to some weird wire language linker, should we absorb this whole library into smartthings +#include + +//***************************************************************************** +// Pin Definitions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +#define PIN_LED 13 +#define PIN_THING_RX 3 +#define PIN_THING_TX 2 + +//***************************************************************************** +// Global Variables | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +SmartThingsCallout_t messageCallout; // call out function forward decalaration +SmartThings smartthing(PIN_THING_RX, PIN_THING_TX, messageCallout); // constructor + +bool isDebugEnabled; // enable or disable debug in this example +int stateLED; // state to track last set value of LED + +//***************************************************************************** +// Local Functions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +void on() +{ + stateLED = 1; // save state as 1 (on) + digitalWrite(PIN_LED, HIGH); // turn LED on + smartthing.shieldSetLED(0, 0, 1); + smartthing.send("on"); // send message to cloud +} + +//***************************************************************************** +void off() +{ + stateLED = 0; // set state to 0 (off) + digitalWrite(PIN_LED, LOW); // turn LED off + smartthing.shieldSetLED(0, 0, 0); + smartthing.send("off"); // send message to cloud +} + +//***************************************************************************** +// API Functions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +void setup() +{ + // setup default state of global variables + isDebugEnabled = true; + stateLED = 0; // matches state of hardware pin set below + + // setup hardware pins + pinMode(PIN_LED, OUTPUT); // define PIN_LED as an output + digitalWrite(PIN_LED, LOW); // set value to LOW (off) to match stateLED=0 + + if (isDebugEnabled) + { // setup debug serial port + Serial.begin(9600); // setup serial with a baud rate of 9600 + Serial.println("setup.."); // print out 'setup..' on start + } +} + +//***************************************************************************** +void loop() +{ + // run smartthing logic + smartthing.run(); +} + +//***************************************************************************** +void messageCallout(String message) +{ + // if debug is enabled print out the received message + if (isDebugEnabled) + { + Serial.print("Received message: '"); + Serial.print(message); + Serial.println("' "); + } + + // if message contents equals to 'on' then call on() function + // else if message contents equals to 'off' then call off() function + if (message.equals("on")) + { + on(); + } + else if (message.equals("off")) + { + off(); + } +} + diff --git a/Arduino/libraries/SmartThings/examples/stLEDwithNetworkStatus/stLEDwithNetworkStatus.ino b/Arduino/libraries/SmartThings/examples/stLEDwithNetworkStatus/stLEDwithNetworkStatus.ino new file mode 100755 index 0000000..d516dce --- /dev/null +++ b/Arduino/libraries/SmartThings/examples/stLEDwithNetworkStatus/stLEDwithNetworkStatus.ino @@ -0,0 +1,164 @@ +//***************************************************************************** +/// @file +/// @brief +/// Arduino SmartThings Shield LED Example with Network Status +/// @note +/// ______________ +/// | | +/// | SW[] | +/// |[]RST | +/// | AREF |-- +/// | GND |-- +/// | 13 |--X LED +/// | 12 |-- +/// | 11 |-- +/// --| 3.3V 10 |-- +/// --| 5V 9 |-- +/// --| GND 8 |-- +/// --| GND | +/// --| Vin 7 |-- +/// | 6 |-- +/// --| A0 5 |-- +/// --| A1 ( ) 4 |-- +/// --| A2 3 |--X THING_RX +/// --| A3 ____ 2 |--X THING_TX +/// --| A4 | | 1 |-- +/// --| A5 | | 0 |-- +/// |____| |____| +/// |____| +/// +//***************************************************************************** +#include //TODO need to set due to some weird wire language linker, should we absorb this whole library into smartthings +#include + +//***************************************************************************** +// Pin Definitions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +#define PIN_LED 13 +#define PIN_THING_RX 3 +#define PIN_THING_TX 2 + +//***************************************************************************** +// Global Variables | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +SmartThingsCallout_t messageCallout; // call out function forward decalaration +SmartThings smartthing(PIN_THING_RX, PIN_THING_TX, messageCallout); // constructor + +bool isDebugEnabled; // enable or disable debug in this example +int stateLED; // state to track last set value of LED +int stateNetwork; // state of the network + +//***************************************************************************** +// Local Functions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +void on() +{ + stateLED = 1; // save state as 1 (on) + digitalWrite(PIN_LED, HIGH); // turn LED on + smartthing.shieldSetLED(0, 0, 2); + smartthing.send("on"); // send message to cloud +} + +//***************************************************************************** +void off() +{ + stateLED = 0; // set state to 0 (off) + digitalWrite(PIN_LED, LOW); // turn LED off + smartthing.shieldSetLED(0, 0, 0); + smartthing.send("off"); // send message to cloud +} + +//***************************************************************************** +void setNetworkStateLED() +{ + SmartThingsNetworkState_t tempState = smartthing.shieldGetLastNetworkState(); + if (tempState != stateNetwork) + { + switch (tempState) + { + case STATE_NO_NETWORK: + if (isDebugEnabled) Serial.println("NO_NETWORK"); + smartthing.shieldSetLED(2, 0, 0); // red + break; + case STATE_JOINING: + if (isDebugEnabled) Serial.println("JOINING"); + smartthing.shieldSetLED(2, 0, 0); // red + break; + case STATE_JOINED: + if (isDebugEnabled) Serial.println("JOINED"); + smartthing.shieldSetLED(0, 0, 0); // off + break; + case STATE_JOINED_NOPARENT: + if (isDebugEnabled) Serial.println("JOINED_NOPARENT"); + smartthing.shieldSetLED(2, 0, 2); // purple + break; + case STATE_LEAVING: + if (isDebugEnabled) Serial.println("LEAVING"); + smartthing.shieldSetLED(2, 0, 0); // red + break; + default: + case STATE_UNKNOWN: + if (isDebugEnabled) Serial.println("UNKNOWN"); + smartthing.shieldSetLED(0, 2, 0); // green + break; + } + stateNetwork = tempState; + } +} + +//***************************************************************************** +// API Functions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +void setup() +{ + // setup default state of global variables + isDebugEnabled = true; + stateLED = 0; // matches state of hardware pin set below + stateNetwork = STATE_JOINED; // set to joined to keep state off if off + + // setup hardware pins + pinMode(PIN_LED, OUTPUT); // define PIN_LED as an output + digitalWrite(PIN_LED, LOW); // set value to LOW (off) to match stateLED=0 + + if (isDebugEnabled) + { // setup debug serial port + Serial.begin(9600); // setup serial with a baud rate of 9600 + Serial.println("setup.."); // print out 'setup..' on start + } +} + +//***************************************************************************** +void loop() +{ + // run smartthing logic + smartthing.run(); + setNetworkStateLED(); +} + +//***************************************************************************** +void messageCallout(String message) +{ + // if debug is enabled print out the received message + if (isDebugEnabled) + { + Serial.print("Received message: '"); + Serial.print(message); + Serial.println("' "); + } + + // if message contents equals to 'on' then call on() function + // else if message contents equals to 'off' then call off() function + if (message.equals("on")) + { + on(); + } + else if (message.equals("off")) + { + off(); + } +} + diff --git a/Arduino/libraries/SmartThings/info.txt b/Arduino/libraries/SmartThings/info.txt new file mode 100755 index 0000000..b9f2faf --- /dev/null +++ b/Arduino/libraries/SmartThings/info.txt @@ -0,0 +1,36 @@ + -------------------------------------------------------------------------------------------------- +| Setup Instructions | + -------------------------------------------------------------------------------------------------- +1) Copy the entire SmartThings directory into the 'libraries' directory in your sketchbook location. + Windows: 'My Documents\Arduino\libraries\SmartThings' + OSX: '~/Documents/Arduino/libraries/SmartThings' + + -------------------------------------------------------------------------------------------------- +| Notes | + -------------------------------------------------------------------------------------------------- + + + -------------------------------------------------------------------------------------------------- +| ChangeLog: | + -------------------------------------------------------------------------------------------------- +01/11/2015 (v0.0.6) do + Added Hardware Serial Constructor + + Added support for Leonardo and MEGA + ~ Performance improvements + ~ Significant SRAM memory optimizations (minimum ~175 bytes, up to 430 bytes) +02/11/2012 (v0.0.5) db + shieldGetLastNetworkStatus to public Class + + example/stLEDwithNetworkStatus + ~ renamed SmartThingsLED to stLED + + ascii diagram for each example documenting pins & usage +02/08/2012 (v0.0.4) db + Add docs/Doxygen + + Begin Framework for working on Leonardo (incomplete) + ~ Minor format cleanup +02/08/2012 (v0.0.3) db ! Fixed regression in last commit with rgb +02/07/2012 (v0.0.2) db ! Fixed typo in send functions + ! Changed write to print for maximal compatibility with serial code + dm ! Point Library to Absolute Path, Add documentation +02/06/2012 (v0.0.1) db ! Lowered Baud to 2400 due to softwareSerial rxBuffer size issue + + Add shield Commands(SetLED, Leave, Find, NetworkStatus) + + Updated Example to also SetLED with on/off control + + Add Doxygen comments & Version to Lib +02/04/2012 (unversioned) db + Initial Commit (currently depends on SoftwareSerial) + diff --git a/Arduino/libraries/SmartThings/keywords.txt b/Arduino/libraries/SmartThings/keywords.txt new file mode 100755 index 0000000..0d9d186 --- /dev/null +++ b/Arduino/libraries/SmartThings/keywords.txt @@ -0,0 +1,18 @@ +####################################### +# Data Types +####################################### +SmartThings KEYWORD1 +SmartThingsCallout_t KEYWORD1 +SmartThingsNetworkState_t KEYWORD1 +SmartThingsSerialType_t KEYWORD1 + +####################################### +# Public Methods / Functions +####################################### +run KEYWORD2 +send KEYWORD2 +shieldSetLED KEYWORD2 +shieldFindNetwork KEYWORD2 +shieldLeaveNetwork KEYWORD2 +shieldGetLastNetworkState KEYWORD2 +shieldGetNetworkState KEYWORD2 From 7a264a305a003ff3dbb03b2c1280721549106d81 Mon Sep 17 00:00:00 2001 From: d8adrvn Date: Wed, 13 May 2015 22:12:37 -0500 Subject: [PATCH 05/15] Checked out and added ST_Anything SmartThings library. Thanks DanielOgorchock --- Arduino/libraries/SmartThings/.svn/entries | 1 + Arduino/libraries/SmartThings/.svn/format | 1 + ...4be6c8c2d4845966392f7c93532d1ab83.svn-base | 1809 +++++++++++++++++ ...67002f5fee09b849ca61e5c5add6a4966.svn-base | 164 ++ ...1033c22a264b629acb73a32b3543cb77c.svn-base | 36 + ...6d71cce67afae28f6240c38326ef41d55.svn-base | 18 + ...cb3e893c2dfbc8f4e18bee0a05a856e8e.svn-base | 123 ++ ...35a323b2bb7d3f1b50d9b8c0fa2698528.svn-base | 231 +++ ...9b12d6f3a58e0c38d927af7c3c0da9014.svn-base | 677 ++++++ Arduino/libraries/SmartThings/.svn/wc.db | Bin 0 -> 118784 bytes Arduino/libraries/SmartThings/SmartThings.cpp | 0 Arduino/libraries/SmartThings/SmartThings.h | 0 Arduino/libraries/SmartThings/docs/Doxyfile | 0 .../SmartThings/examples/stLED/stLED.ino | 0 .../stLEDwithNetworkStatus.ino | 0 Arduino/libraries/SmartThings/info.txt | 0 Arduino/libraries/SmartThings/keywords.txt | 0 17 files changed, 3060 insertions(+) create mode 100644 Arduino/libraries/SmartThings/.svn/entries create mode 100644 Arduino/libraries/SmartThings/.svn/format create mode 100644 Arduino/libraries/SmartThings/.svn/pristine/0e/0eb452a4be6c8c2d4845966392f7c93532d1ab83.svn-base create mode 100644 Arduino/libraries/SmartThings/.svn/pristine/3b/3b72cff67002f5fee09b849ca61e5c5add6a4966.svn-base create mode 100644 Arduino/libraries/SmartThings/.svn/pristine/3d/3d706401033c22a264b629acb73a32b3543cb77c.svn-base create mode 100644 Arduino/libraries/SmartThings/.svn/pristine/56/56de6cf6d71cce67afae28f6240c38326ef41d55.svn-base create mode 100644 Arduino/libraries/SmartThings/.svn/pristine/63/6395cb1cb3e893c2dfbc8f4e18bee0a05a856e8e.svn-base create mode 100644 Arduino/libraries/SmartThings/.svn/pristine/95/95d42b835a323b2bb7d3f1b50d9b8c0fa2698528.svn-base create mode 100644 Arduino/libraries/SmartThings/.svn/pristine/d4/d4c21739b12d6f3a58e0c38d927af7c3c0da9014.svn-base create mode 100644 Arduino/libraries/SmartThings/.svn/wc.db mode change 100755 => 100644 Arduino/libraries/SmartThings/SmartThings.cpp mode change 100755 => 100644 Arduino/libraries/SmartThings/SmartThings.h mode change 100755 => 100644 Arduino/libraries/SmartThings/docs/Doxyfile mode change 100755 => 100644 Arduino/libraries/SmartThings/examples/stLED/stLED.ino mode change 100755 => 100644 Arduino/libraries/SmartThings/examples/stLEDwithNetworkStatus/stLEDwithNetworkStatus.ino mode change 100755 => 100644 Arduino/libraries/SmartThings/info.txt mode change 100755 => 100644 Arduino/libraries/SmartThings/keywords.txt diff --git a/Arduino/libraries/SmartThings/.svn/entries b/Arduino/libraries/SmartThings/.svn/entries new file mode 100644 index 0000000..48082f7 --- /dev/null +++ b/Arduino/libraries/SmartThings/.svn/entries @@ -0,0 +1 @@ +12 diff --git a/Arduino/libraries/SmartThings/.svn/format b/Arduino/libraries/SmartThings/.svn/format new file mode 100644 index 0000000..48082f7 --- /dev/null +++ b/Arduino/libraries/SmartThings/.svn/format @@ -0,0 +1 @@ +12 diff --git a/Arduino/libraries/SmartThings/.svn/pristine/0e/0eb452a4be6c8c2d4845966392f7c93532d1ab83.svn-base b/Arduino/libraries/SmartThings/.svn/pristine/0e/0eb452a4be6c8c2d4845966392f7c93532d1ab83.svn-base new file mode 100644 index 0000000..9fa55a0 --- /dev/null +++ b/Arduino/libraries/SmartThings/.svn/pristine/0e/0eb452a4be6c8c2d4845966392f7c93532d1ab83.svn-base @@ -0,0 +1,1809 @@ +tt# Doxyfile 1.8.2 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" "). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = "SmartThings Arduino Shield" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = "\r\n" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "SmartThings Arduino Shield Library Interface" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = "logo.gif" + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = "SmartThings Arduino Shield Interface" + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = YES + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, +# and language is one of the parsers supported by doxygen: IDL, Java, +# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, +# C++. For instance to make doxygen treat .inc files as Fortran files (default +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented classes, +# or namespaces to their corresponding documentation. Such a link can be +# prevented in individual cases by by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +SYMBOL_CACHE_SIZE = 0 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ../ # \ + # indexDoc.txt + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = *.h + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C, C++ and Fortran comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 4 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. + +HTML_DYNAMIC_SECTIONS = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely +# identify the documentation publisher. This should be a reverse domain-name +# style string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = letter + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/Arduino/libraries/SmartThings/.svn/pristine/3b/3b72cff67002f5fee09b849ca61e5c5add6a4966.svn-base b/Arduino/libraries/SmartThings/.svn/pristine/3b/3b72cff67002f5fee09b849ca61e5c5add6a4966.svn-base new file mode 100644 index 0000000..d516dce --- /dev/null +++ b/Arduino/libraries/SmartThings/.svn/pristine/3b/3b72cff67002f5fee09b849ca61e5c5add6a4966.svn-base @@ -0,0 +1,164 @@ +//***************************************************************************** +/// @file +/// @brief +/// Arduino SmartThings Shield LED Example with Network Status +/// @note +/// ______________ +/// | | +/// | SW[] | +/// |[]RST | +/// | AREF |-- +/// | GND |-- +/// | 13 |--X LED +/// | 12 |-- +/// | 11 |-- +/// --| 3.3V 10 |-- +/// --| 5V 9 |-- +/// --| GND 8 |-- +/// --| GND | +/// --| Vin 7 |-- +/// | 6 |-- +/// --| A0 5 |-- +/// --| A1 ( ) 4 |-- +/// --| A2 3 |--X THING_RX +/// --| A3 ____ 2 |--X THING_TX +/// --| A4 | | 1 |-- +/// --| A5 | | 0 |-- +/// |____| |____| +/// |____| +/// +//***************************************************************************** +#include //TODO need to set due to some weird wire language linker, should we absorb this whole library into smartthings +#include + +//***************************************************************************** +// Pin Definitions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +#define PIN_LED 13 +#define PIN_THING_RX 3 +#define PIN_THING_TX 2 + +//***************************************************************************** +// Global Variables | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +SmartThingsCallout_t messageCallout; // call out function forward decalaration +SmartThings smartthing(PIN_THING_RX, PIN_THING_TX, messageCallout); // constructor + +bool isDebugEnabled; // enable or disable debug in this example +int stateLED; // state to track last set value of LED +int stateNetwork; // state of the network + +//***************************************************************************** +// Local Functions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +void on() +{ + stateLED = 1; // save state as 1 (on) + digitalWrite(PIN_LED, HIGH); // turn LED on + smartthing.shieldSetLED(0, 0, 2); + smartthing.send("on"); // send message to cloud +} + +//***************************************************************************** +void off() +{ + stateLED = 0; // set state to 0 (off) + digitalWrite(PIN_LED, LOW); // turn LED off + smartthing.shieldSetLED(0, 0, 0); + smartthing.send("off"); // send message to cloud +} + +//***************************************************************************** +void setNetworkStateLED() +{ + SmartThingsNetworkState_t tempState = smartthing.shieldGetLastNetworkState(); + if (tempState != stateNetwork) + { + switch (tempState) + { + case STATE_NO_NETWORK: + if (isDebugEnabled) Serial.println("NO_NETWORK"); + smartthing.shieldSetLED(2, 0, 0); // red + break; + case STATE_JOINING: + if (isDebugEnabled) Serial.println("JOINING"); + smartthing.shieldSetLED(2, 0, 0); // red + break; + case STATE_JOINED: + if (isDebugEnabled) Serial.println("JOINED"); + smartthing.shieldSetLED(0, 0, 0); // off + break; + case STATE_JOINED_NOPARENT: + if (isDebugEnabled) Serial.println("JOINED_NOPARENT"); + smartthing.shieldSetLED(2, 0, 2); // purple + break; + case STATE_LEAVING: + if (isDebugEnabled) Serial.println("LEAVING"); + smartthing.shieldSetLED(2, 0, 0); // red + break; + default: + case STATE_UNKNOWN: + if (isDebugEnabled) Serial.println("UNKNOWN"); + smartthing.shieldSetLED(0, 2, 0); // green + break; + } + stateNetwork = tempState; + } +} + +//***************************************************************************** +// API Functions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +void setup() +{ + // setup default state of global variables + isDebugEnabled = true; + stateLED = 0; // matches state of hardware pin set below + stateNetwork = STATE_JOINED; // set to joined to keep state off if off + + // setup hardware pins + pinMode(PIN_LED, OUTPUT); // define PIN_LED as an output + digitalWrite(PIN_LED, LOW); // set value to LOW (off) to match stateLED=0 + + if (isDebugEnabled) + { // setup debug serial port + Serial.begin(9600); // setup serial with a baud rate of 9600 + Serial.println("setup.."); // print out 'setup..' on start + } +} + +//***************************************************************************** +void loop() +{ + // run smartthing logic + smartthing.run(); + setNetworkStateLED(); +} + +//***************************************************************************** +void messageCallout(String message) +{ + // if debug is enabled print out the received message + if (isDebugEnabled) + { + Serial.print("Received message: '"); + Serial.print(message); + Serial.println("' "); + } + + // if message contents equals to 'on' then call on() function + // else if message contents equals to 'off' then call off() function + if (message.equals("on")) + { + on(); + } + else if (message.equals("off")) + { + off(); + } +} + diff --git a/Arduino/libraries/SmartThings/.svn/pristine/3d/3d706401033c22a264b629acb73a32b3543cb77c.svn-base b/Arduino/libraries/SmartThings/.svn/pristine/3d/3d706401033c22a264b629acb73a32b3543cb77c.svn-base new file mode 100644 index 0000000..b9f2faf --- /dev/null +++ b/Arduino/libraries/SmartThings/.svn/pristine/3d/3d706401033c22a264b629acb73a32b3543cb77c.svn-base @@ -0,0 +1,36 @@ + -------------------------------------------------------------------------------------------------- +| Setup Instructions | + -------------------------------------------------------------------------------------------------- +1) Copy the entire SmartThings directory into the 'libraries' directory in your sketchbook location. + Windows: 'My Documents\Arduino\libraries\SmartThings' + OSX: '~/Documents/Arduino/libraries/SmartThings' + + -------------------------------------------------------------------------------------------------- +| Notes | + -------------------------------------------------------------------------------------------------- + + + -------------------------------------------------------------------------------------------------- +| ChangeLog: | + -------------------------------------------------------------------------------------------------- +01/11/2015 (v0.0.6) do + Added Hardware Serial Constructor + + Added support for Leonardo and MEGA + ~ Performance improvements + ~ Significant SRAM memory optimizations (minimum ~175 bytes, up to 430 bytes) +02/11/2012 (v0.0.5) db + shieldGetLastNetworkStatus to public Class + + example/stLEDwithNetworkStatus + ~ renamed SmartThingsLED to stLED + + ascii diagram for each example documenting pins & usage +02/08/2012 (v0.0.4) db + Add docs/Doxygen + + Begin Framework for working on Leonardo (incomplete) + ~ Minor format cleanup +02/08/2012 (v0.0.3) db ! Fixed regression in last commit with rgb +02/07/2012 (v0.0.2) db ! Fixed typo in send functions + ! Changed write to print for maximal compatibility with serial code + dm ! Point Library to Absolute Path, Add documentation +02/06/2012 (v0.0.1) db ! Lowered Baud to 2400 due to softwareSerial rxBuffer size issue + + Add shield Commands(SetLED, Leave, Find, NetworkStatus) + + Updated Example to also SetLED with on/off control + + Add Doxygen comments & Version to Lib +02/04/2012 (unversioned) db + Initial Commit (currently depends on SoftwareSerial) + diff --git a/Arduino/libraries/SmartThings/.svn/pristine/56/56de6cf6d71cce67afae28f6240c38326ef41d55.svn-base b/Arduino/libraries/SmartThings/.svn/pristine/56/56de6cf6d71cce67afae28f6240c38326ef41d55.svn-base new file mode 100644 index 0000000..0d9d186 --- /dev/null +++ b/Arduino/libraries/SmartThings/.svn/pristine/56/56de6cf6d71cce67afae28f6240c38326ef41d55.svn-base @@ -0,0 +1,18 @@ +####################################### +# Data Types +####################################### +SmartThings KEYWORD1 +SmartThingsCallout_t KEYWORD1 +SmartThingsNetworkState_t KEYWORD1 +SmartThingsSerialType_t KEYWORD1 + +####################################### +# Public Methods / Functions +####################################### +run KEYWORD2 +send KEYWORD2 +shieldSetLED KEYWORD2 +shieldFindNetwork KEYWORD2 +shieldLeaveNetwork KEYWORD2 +shieldGetLastNetworkState KEYWORD2 +shieldGetNetworkState KEYWORD2 diff --git a/Arduino/libraries/SmartThings/.svn/pristine/63/6395cb1cb3e893c2dfbc8f4e18bee0a05a856e8e.svn-base b/Arduino/libraries/SmartThings/.svn/pristine/63/6395cb1cb3e893c2dfbc8f4e18bee0a05a856e8e.svn-base new file mode 100644 index 0000000..3eef3df --- /dev/null +++ b/Arduino/libraries/SmartThings/.svn/pristine/63/6395cb1cb3e893c2dfbc8f4e18bee0a05a856e8e.svn-base @@ -0,0 +1,123 @@ +//***************************************************************************** +/// @file +/// @brief +/// Arduino SmartThings Shield LED Example +/// @note +/// ______________ +/// | | +/// | SW[] | +/// |[]RST | +/// | AREF |-- +/// | GND |-- +/// | 13 |--X LED +/// | 12 |-- +/// | 11 |-- +/// --| 3.3V 10 |-- +/// --| 5V 9 |-- +/// --| GND 8 |-- +/// --| GND | +/// --| Vin 7 |-- +/// | 6 |-- +/// --| A0 5 |-- +/// --| A1 ( ) 4 |-- +/// --| A2 3 |--X THING_RX +/// --| A3 ____ 2 |--X THING_TX +/// --| A4 | | 1 |-- +/// --| A5 | | 0 |-- +/// |____| |____| +/// |____| +/// +//***************************************************************************** +#include //TODO need to set due to some weird wire language linker, should we absorb this whole library into smartthings +#include + +//***************************************************************************** +// Pin Definitions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +#define PIN_LED 13 +#define PIN_THING_RX 3 +#define PIN_THING_TX 2 + +//***************************************************************************** +// Global Variables | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +SmartThingsCallout_t messageCallout; // call out function forward decalaration +SmartThings smartthing(PIN_THING_RX, PIN_THING_TX, messageCallout); // constructor + +bool isDebugEnabled; // enable or disable debug in this example +int stateLED; // state to track last set value of LED + +//***************************************************************************** +// Local Functions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +void on() +{ + stateLED = 1; // save state as 1 (on) + digitalWrite(PIN_LED, HIGH); // turn LED on + smartthing.shieldSetLED(0, 0, 1); + smartthing.send("on"); // send message to cloud +} + +//***************************************************************************** +void off() +{ + stateLED = 0; // set state to 0 (off) + digitalWrite(PIN_LED, LOW); // turn LED off + smartthing.shieldSetLED(0, 0, 0); + smartthing.send("off"); // send message to cloud +} + +//***************************************************************************** +// API Functions | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** +void setup() +{ + // setup default state of global variables + isDebugEnabled = true; + stateLED = 0; // matches state of hardware pin set below + + // setup hardware pins + pinMode(PIN_LED, OUTPUT); // define PIN_LED as an output + digitalWrite(PIN_LED, LOW); // set value to LOW (off) to match stateLED=0 + + if (isDebugEnabled) + { // setup debug serial port + Serial.begin(9600); // setup serial with a baud rate of 9600 + Serial.println("setup.."); // print out 'setup..' on start + } +} + +//***************************************************************************** +void loop() +{ + // run smartthing logic + smartthing.run(); +} + +//***************************************************************************** +void messageCallout(String message) +{ + // if debug is enabled print out the received message + if (isDebugEnabled) + { + Serial.print("Received message: '"); + Serial.print(message); + Serial.println("' "); + } + + // if message contents equals to 'on' then call on() function + // else if message contents equals to 'off' then call off() function + if (message.equals("on")) + { + on(); + } + else if (message.equals("off")) + { + off(); + } +} + diff --git a/Arduino/libraries/SmartThings/.svn/pristine/95/95d42b835a323b2bb7d3f1b50d9b8c0fa2698528.svn-base b/Arduino/libraries/SmartThings/.svn/pristine/95/95d42b835a323b2bb7d3f1b50d9b8c0fa2698528.svn-base new file mode 100644 index 0000000..dcf7513 --- /dev/null +++ b/Arduino/libraries/SmartThings/.svn/pristine/95/95d42b835a323b2bb7d3f1b50d9b8c0fa2698528.svn-base @@ -0,0 +1,231 @@ +//******************************************************************************* +/// @file +/// @brief +/// SmartThings Arduino Library +/// @section License +/// (C) Copyright 2013 Physical Graph +/// +/// Updates by Daniel Ogorchock 12/30/2014 - Arduino Mega 2560 HW Serial support +/// -Numerous performance and size optimizations (helpful on UNO with only 2K SRAM) +/// -Arduino UNO should use the SoftwareSerial library Constructor since the UNO has +/// only one Hardware UART port ("Serial") which is used by the USB port for +/// programming and debugging typically. UNO can use the Hardware "Serial" +/// if desired, but USB programming and debug will be troublesome. +/// Leonardo and Mega can use SoftwareSerial BUT cannot use Pin3 for Rx - use +/// Pin10 for Rx and add jumper from Pin10 to Pin3. +/// -Arduino MEGA should use the Hardware Serial Constructor since it has 4 UARTs. +/// "Serial3" port uses pins 14(Tx) and 15(Rx). Wire Pin14 to Pin2 and Pin15 to Pin3. +/// -Be certain to not use Pins 2 & 3 in your Arduino sketch for I/O since they are +/// electrically connected to the ThingShield. +/// -Note - Pin6 is reserved by the ThingShield as well. Best to avoid using it. +/// -The SoftwareSerial library has the following known limitations: +/// - If using multiple software serial ports, only one can receive data at a time. +/// - Not all pins on the Mega and Mega 2560 support change interrupts, so only +/// the following can be used for RX: 10, 11, 12, 13, 14, 15, 50, 51, 52, 53, +/// A8(62), A9(63), A10(64), A11(65), A12(66), A13(67), A14(68), A15(69). +/// - Not all pins on the Leonardo and Micro support change interrupts, so only +/// the following can be used for RX : 8, 9, 10, 11, 14 (MISO), 15 (SCK), 16 (MOSI). +//******************************************************************************* +#ifndef __SMARTTHINGS_H__ +#define __SMARTTHINGS_H__ + +//******************************************************************************* +#define BOARD_TYPE_UNO 0 +#define BOARD_TYPE_LEONARDO 1 +#define BOARD_TYPE_MEGA 2 +//******************************************************************************* + +//#define DISABLE_SOFTWARESERIAL // uncomment to disable SoftwareSerial to save space if using HW Serial + +#include +#include +#ifndef DISABLE_SOFTWARESERIAL +#include +#endif + + +//******************************************************************************* +// Set the correct board type automatically +//******************************************************************************* +#if defined(__AVR_ATmega168__) || defined(__AVR_ATmega328__) || defined(__AVR_ATmega328P__) +#define BOARD_TYPE BOARD_TYPE_UNO +#elif defined(__AVR_ATmega32U4__) +#define BOARD_TYPE BOARD_TYPE_LEONARDO +#elif defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) +#define BOARD_TYPE BOARD_TYPE_MEGA +#else //assume user is using an UNO for the unknown case +#define BOARD_TYPE BOARD_TYPE_UNO +#endif + +//******************************************************************************* + +//******************************************************************************* +/// @brief SmartThings Arduino Library Version +//******************************************************************************* +#define SMARTTHINGSLIB_VERSION_MAJOR 0 +#define SMARTTHINGSLIB_VERSION_MINOR 0 +#define SMARTTHINGSLIB_VERSION_BUILD 6 + +#define SMARTTHINGSLIB_VERSION \ + (((SMARTTHINGSLIB_VERSION_MAJOR & 0xFF) << 24) | \ + ((SMARTTHINGSLIB_VERSION_MINOR & 0xFF) << 16) | \ + (SMARTTHINGSLIB_VERSION_BUILD & 0xFFFF)) + +//******************************************************************************* +#define SMARTTHINGS_RX_BUFFER_SIZE 256 // if > 255: change _nBufRX to u16 +#define SMARTTHINGS_SHIELDTYPE_SIZE 32 // if > 255: change _shieldTypeLen to u16 + +//******************************************************************************* +/// @brief Callout Function Definition for Messages Received over ZigBee Network +//******************************************************************************* +typedef void SmartThingsCallout_t(String message); + +//******************************************************************************* +/// @brief ZigBee Network State Definition +//******************************************************************************* +typedef enum +{ + STATE_NO_NETWORK, + STATE_JOINING, + STATE_JOINED, + STATE_JOINED_NOPARENT, + STATE_LEAVING, + STATE_UNKNOWN +} SmartThingsNetworkState_t; + +//******************************************************************************* +/// @brief Serial Communication Type Definition +//******************************************************************************* +typedef enum +{ + SW_SERIAL, + HW_SERIAL, + HW_SERIAL1, + HW_SERIAL2, + HW_SERIAL3 +} SmartThingsSerialType_t; + +//******************************************************************************* + +class SmartThings +{ +private: +#ifndef DISABLE_SOFTWARESERIAL + SoftwareSerial _mySerial; +#endif + SmartThingsSerialType_t _SerialPort; + SmartThingsCallout_t *_calloutFunction; + bool _isDebugEnabled; + uint32_t _lastPingMS; + uint32_t _lastShieldMS; + + SmartThingsNetworkState_t _networkState; + uint8_t _eui64[8]; + uint16_t _nodeID; + + //Removed for now to save SRAM space - Not sure why ST included this as it is never used in the library + //uint8_t _shieldTypeBuf[SMARTTHINGS_SHIELDTYPE_SIZE]; + //uint8_t _shieldTypeLen; + + uint8_t _pBufRX[SMARTTHINGS_RX_BUFFER_SIZE]; + uint_fast8_t _nBufRX; + + void _shieldGetNetworkInfo(void); + void _process(void); + + void debugPrintBuffer(String prefix, uint8_t * pBuf, uint_fast8_t nBuf); + bool isRxLine(uint8_t * pLine); + bool isAsciiHex(uint8_t ascii); + uint8_t asciiToHexU8(uint8_t pAscii[2]); + uint_fast8_t translatePayload(uint8_t *pBuf, uint_fast8_t nBuf); + void handleLine(void); + void st_begin(long); + int st_available(); + int st_read(); + long st_print(String); + long st_print(char); + long st_print(char, int); + byte st_write(uint8_t); + + +public: + //******************************************************************************* + /// @brief SmartThings SoftwareSerial Constructor + /// @param[in] pinRX - Receive Pin for the SoftwareSerial Port to the Arduino + /// @param[in] pinTX - Transmit Pin for the SoftwareSerial Port to the Arduino + /// @param[in] callout - Set the Callout Function that is called on Msg Reception + /// @param[in] shieldType (optional) - Set the Reported SheildType to the Server + /// @param[in] enableDebug (optional) - Enable internal Library debug + //******************************************************************************* +#ifndef DISABLE_SOFTWARESERIAL + SmartThings(uint8_t pinRX, uint8_t pinTX, SmartThingsCallout_t *callout, String shieldType = "GenericShield", bool enableDebug = false); +#endif + //******************************************************************************* + /// @brief SmartThings HardwareSerial Constructor + /// @param[in] hwSerialPort - enum of Hardware Serial Port to the Arduino + /// @param[in] callout - Set the Callout Function that is called on Msg Reception + /// @param[in] shieldType (optional) - Set the Reported SheildType to the Server + /// @param[in] enableDebug (optional) - Enable internal Library debug + //******************************************************************************* + SmartThings(SmartThingsSerialType_t hwSerialPort, SmartThingsCallout_t *callout, String shieldType = "GenericShield", bool enableDebug = false); + + //******************************************************************************* + /// @brief Descructor + //******************************************************************************* + ~SmartThings(); + + //******************************************************************************* + /// @brief Run SmartThings Library + //******************************************************************************* + void run(void); + + //******************************************************************************* + /// @brief Send Message out over ZigBee to the Hub + /// @param[in] message to send + //******************************************************************************* + void send(String message); + + //******************************************************************************* + /// @brief Set SmartThings Shield MultiColor LED + /// @param[in] red: intensity {0=off to 9=max} + /// @param[in] green: intensity {0=off to 9=max} + /// @param[in] blue: intensity {0=off to 9=max} + //******************************************************************************* + void shieldSetLED(uint8_t red, uint8_t green, uint8_t blue); + + //******************************************************************************* + /// @brief Get Last Read Shield State + /// @return Last Read Network State + //******************************************************************************* + SmartThingsNetworkState_t shieldGetLastNetworkState(void); + + //******************************************************************************* + /// @brief Get Last Read Shield State and Trigger Refresh of Network Info + /// @return Last Read Network State + //******************************************************************************* + SmartThingsNetworkState_t shieldGetNetworkState(void); + + //******************************************************************************* + /// @brief Get Last Read NodeID and Trigger Refresh of Network Info + /// @return Last Read NodeID + //******************************************************************************* + uint16_t shieldGetNodeID(void); + + //******************************************************************************* + /// @brief Get Last Read EUI64 and Trigger Refresh of Network Info + /// @return Last Read EUI64 + //******************************************************************************* + void shieldGetEUI64(uint8_t eui[8]); + + //******************************************************************************* + /// @brief Find and Join a Network + //******************************************************************************* + void shieldFindNetwork(void); + + //******************************************************************************* + /// @brief Leave the Current ZigBee Network + //******************************************************************************* + void shieldLeaveNetwork(void); +}; + +#endif diff --git a/Arduino/libraries/SmartThings/.svn/pristine/d4/d4c21739b12d6f3a58e0c38d927af7c3c0da9014.svn-base b/Arduino/libraries/SmartThings/.svn/pristine/d4/d4c21739b12d6f3a58e0c38d927af7c3c0da9014.svn-base new file mode 100644 index 0000000..814014a --- /dev/null +++ b/Arduino/libraries/SmartThings/.svn/pristine/d4/d4c21739b12d6f3a58e0c38d927af7c3c0da9014.svn-base @@ -0,0 +1,677 @@ +//******************************************************************************* +/// @file +/// @brief +/// SmartThings Arduino Library +/// @section License +/// (C) Copyright 2013 Physical Graph +/// +/// Updates by Daniel Ogorchock 12/30/2014 - Arduino Mega 2560 HW Serial support +/// -Numerous performance and size optimizations (helpful on UNO with only 2K SRAM) +/// -Arduino UNO should use the SoftwareSerial library Constructor since the UNO has +/// only one Hardware UART port ("Serial") which is used by the USB port for +/// programming and debugging typically. UNO can use the Hardware "Serial" +/// if desired, but USB programming and debug will be troublesome. +/// Leonardo and Mega can use SoftwareSerial BUT cannot use Pin3 for Rx - use +/// Pin10 for Rx and add jumper from Pin10 to Pin3. +/// -Arduino MEGA should use the Hardware Serial Constructor since it has 4 UARTs. +/// "Serial3" port uses pins 14(Tx) and 15(Rx). Wire Pin14 to Pin2 and Pin15 to Pin3. +/// -Be certain to not use Pins 2 & 3 in your Arduino sketch for I/O since they are +/// electrically connected to the ThingShield. +/// -Note - Pin6 is reserved by the ThingShield as well. Best to avoid using it. +/// -The SoftwareSerial library has the following known limitations: +/// - If using multiple software serial ports, only one can receive data at a time. +/// - Not all pins on the Mega and Mega 2560 support change interrupts, so only +/// the following can be used for RX: 10, 11, 12, 13, 14, 15, 50, 51, 52, 53, +/// A8(62), A9(63), A10(64), A11(65), A12(66), A13(67), A14(68), A15(69). +/// - Not all pins on the Leonardo and Micro support change interrupts, so only +/// the following can be used for RX : 8, 9, 10, 11, 14 (MISO), 15 (SCK), 16 (MOSI). +//******************************************************************************* +#include + +//***************************************************************************** +void SmartThings::debugPrintBuffer(String prefix, uint8_t * pBuf, uint_fast8_t nBuf) +{ + if (_isDebugEnabled) + { + Serial.print(prefix); + for (uint_fast8_t i = 0; i < nBuf; i++) + { + Serial.print(char(pBuf[i])); + } + Serial.println(); + } +} + +//***************************************************************************** +bool SmartThings::isRxLine(uint8_t * pLine) +{ + // line starts with "T00000000:RX" + //int validRxLineLength = 12; // TODO: What is a real value for this length? + + // return line.length > validRxLineLength && line[0] == 'T' && line[9] = ':' && line[10] == 'R' && line[11] == 'X'; + return ((pLine[0] == 'T') && (pLine[9] == ':') && (pLine[10] == 'R') && (pLine[11] == 'X')); +} + +//******************************************************************************* +bool SmartThings::isAsciiHex(uint8_t ascii) +{ + bool retVal = false; + if ( + ((ascii >= 'A') && (ascii <= 'F')) || + ((ascii >= 'a') && (ascii <= 'f')) || + ((ascii >= '0') && (ascii <= '9')) + ) + { + retVal = true; + } + return retVal; +} + +//******************************************************************************* +/// @note this function doesn't check for hex validity before converting +//******************************************************************************* +uint8_t SmartThings::asciiToHexU8(uint8_t pAscii[2]) +{ + uint8_t hex; + hex = ((pAscii[0] - (((pAscii[0] >> 6) & 0x1) * 0x37)) & 0xF); + hex <<= 4; + hex |= ((pAscii[1] - (((pAscii[1] >> 6) & 0x1) * 0x37)) & 0xF); + return hex; +} + +//***************************************************************************** +uint_fast8_t SmartThings::translatePayload(uint8_t *pBuf, uint_fast8_t nBuf) +{ + uint_fast8_t payloadLength = 0; // return value + uint_fast8_t payloadStart = 0; + uint_fast8_t payloadEnd = 0; + + uint_fast8_t i; + + // find [ ] message from the back of the message + for (i = nBuf - 1; i > 0; i--) + { + if (pBuf[i] == ']') + { + payloadEnd = i; + } + else if (pBuf[i] == '[') + { + payloadStart = i; + break; + } + } + + + if (_isDebugEnabled) + { + Serial.print(F("payload start: ")); + Serial.print(payloadStart); + Serial.print(F(" end: ")); + Serial.print(payloadEnd); + Serial.print(F(" : ")); + for (i = payloadStart + 1; i < payloadEnd; i++) + { + Serial.print(pBuf[i]); + Serial.print(' '); + } + Serial.println(); + } + + // int expectedPayloadLength = (payloadEnd - payloadStart) / 3; // TODO: Verify this, but 2 chars for byte and 1 for space char + // char payloadString[expectedPayloadLength]; + if ((payloadStart != 0) && (payloadEnd != 0) && (payloadEnd - payloadStart > 4) && (pBuf[payloadStart + 1] == '0') && (pBuf[payloadStart + 2] == 'A')) + { // if valid message then parse + i = payloadStart + 4; // start+3 should be ' ' + while (i < payloadEnd) + { + if (pBuf[i] != ' ') + { + if (isAsciiHex(pBuf[i]) && isAsciiHex(pBuf[i + 1])) + { + pBuf[payloadLength++] = asciiToHexU8(&(pBuf[i++])); + } + } + i++; + } + } + + pBuf[payloadLength] = 0x0; // null-terminate the string + return payloadLength; +} + +//***************************************************************************** +void SmartThings::_process(void) +{ + uint32_t nowMilliseconds = millis(); + + if ((nowMilliseconds < _lastShieldMS) || ((nowMilliseconds - _lastShieldMS) > 5000)) + { + _shieldGetNetworkInfo(); + _lastShieldMS = nowMilliseconds; + } + else if ((_networkState == STATE_JOINED) && + ((nowMilliseconds < _lastPingMS) || ((nowMilliseconds - _lastPingMS) > 60000))) + { // ping every minutes or on rollover + send("ping"); + _lastPingMS = nowMilliseconds; + } + + // check for return character +} + +//***************************************************************************** +void SmartThings::handleLine(void) +{ + if (_nBufRX > 0) + { + if (isRxLine(_pBufRX)) + { + debugPrintBuffer("->| ", _pBufRX, _nBufRX); + { + //char messageBuf[255]; // TODO: Figure this out + uint_fast8_t messageBufLength = translatePayload(_pBufRX, _nBufRX); + + if (messageBufLength > 0) + { + debugPrintBuffer("->| payload :: ", (uint8_t *)_pBufRX, messageBufLength); + + _calloutFunction(String((char *)_pBufRX)); // call out to main application + // that.handleSmartThingMessage(message); + } + else + { + debugPrintBuffer("->| no payload from :: ", _pBufRX, _nBufRX); + } + } + } + else + { //XXX Totally slapped together since this is temp-- will go away with command set change + uint_fast8_t i = 0; + bool found = false; + if (_nBufRX >= 32) //netinfo:0022A3000000B675,E30E,02 + { + while (i < _nBufRX) + { + if ( + (_pBufRX[i] == 'n') && + (_pBufRX[i + 1] == 'e') && + (_pBufRX[i + 2] == 't') && + (_pBufRX[i + 3] == 'i') && + (_pBufRX[i + 4] == 'n') && + (_pBufRX[i + 5] == 'f') && + (_pBufRX[i + 6] == 'o') && + (_pBufRX[i + 7] == ':') && + (_pBufRX[i + 24] == ',') && + (_pBufRX[i + 29] == ',') + ) + { + // parse off EUI + if ( + isAsciiHex(_pBufRX[i + 8]) && + isAsciiHex(_pBufRX[i + 9]) && + isAsciiHex(_pBufRX[i + 10]) && + isAsciiHex(_pBufRX[i + 11]) && + isAsciiHex(_pBufRX[i + 12]) && + isAsciiHex(_pBufRX[i + 13]) && + isAsciiHex(_pBufRX[i + 14]) && + isAsciiHex(_pBufRX[i + 15]) && + isAsciiHex(_pBufRX[i + 16]) && + isAsciiHex(_pBufRX[i + 17]) && + isAsciiHex(_pBufRX[i + 18]) && + isAsciiHex(_pBufRX[i + 19]) && + isAsciiHex(_pBufRX[i + 20]) && + isAsciiHex(_pBufRX[i + 21]) && + isAsciiHex(_pBufRX[i + 22]) && + isAsciiHex(_pBufRX[i + 23]) && + + isAsciiHex(_pBufRX[i + 25]) && + isAsciiHex(_pBufRX[i + 26]) && + isAsciiHex(_pBufRX[i + 27]) && + isAsciiHex(_pBufRX[i + 28]) && + + isAsciiHex(_pBufRX[i + 30]) && + isAsciiHex(_pBufRX[i + 31]) + ) + { + uint8_t tempNetStat = asciiToHexU8(&(_pBufRX[i + 30])); + if (tempNetStat <= STATE_LEAVING) // make sure it maps to the enum + { + _networkState = (SmartThingsNetworkState_t)tempNetStat; + + _nodeID = asciiToHexU8(&(_pBufRX[i + 25])); + _nodeID <<= 8; + _nodeID |= asciiToHexU8(&(_pBufRX[i + 27])); + + _eui64[7] = asciiToHexU8(&(_pBufRX[i + 8])); + _eui64[6] = asciiToHexU8(&(_pBufRX[i + 10])); + _eui64[5] = asciiToHexU8(&(_pBufRX[i + 12])); + _eui64[4] = asciiToHexU8(&(_pBufRX[i + 14])); + _eui64[3] = asciiToHexU8(&(_pBufRX[i + 16])); + _eui64[2] = asciiToHexU8(&(_pBufRX[i + 18])); + _eui64[1] = asciiToHexU8(&(_pBufRX[i + 20])); + _eui64[0] = asciiToHexU8(&(_pBufRX[i + 22])); + + debugPrintBuffer(" |~> ", &(_pBufRX[i]), 32); + found = true; + } + } + } + i++; + } + } + if (found == false) + debugPrintBuffer("->| IGNORING :: ", _pBufRX, _nBufRX); + } + _nBufRX = 0; + } +} +//***************************************************************************** +void SmartThings::_shieldGetNetworkInfo(void) +{ + st_print(F("custom netinfo\n")); + + if (_isDebugEnabled) + { + Serial.print(F(" |<~ custom netinfo\n")); + } +} + +//***************************************************************************** +// Thing API | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +// V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V +//***************************************************************************** + +// SoftwareSerial Constructor +#ifndef DISABLE_SOFTWARESERIAL +SmartThings::SmartThings(uint8_t pinRX, uint8_t pinTX, SmartThingsCallout_t *callout, String shieldType, bool enableDebug) : + _mySerial(pinRX, pinTX), + _SerialPort(SW_SERIAL), + _calloutFunction(callout), + _isDebugEnabled(enableDebug), + _lastPingMS(0xFFFFFF00), + _lastShieldMS(0xFFFFFF00), + _networkState(STATE_UNKNOWN), + _nBufRX(0) +{ + //Removed for now to save SRAM space - Not sure why ST included this as it is never used in the library + //uint_fast8_t i = shieldType.length(); + //if (i > 32) + // i = 32; + //_shieldTypeLen = i; + + //while (i--) + //{ + // _shieldTypeBuf[i] = (uint8_t)shieldType[i]; + //} + + st_begin(2400); +} +#endif +//Hardware Serial Constructor +SmartThings::SmartThings(SmartThingsSerialType_t hwSerialPort, SmartThingsCallout_t *callout, String shieldType, bool enableDebug) : +#ifndef DISABLE_SOFTWARESERIAL + _mySerial(254, 255), //Needed unless you uncomment the "#define DISABLE_SOFTWARESERIAL" to prevent compiler error (SmartThings.h) +#endif + _SerialPort(hwSerialPort), + _calloutFunction(callout), + _isDebugEnabled(hwSerialPort != HW_SERIAL ? enableDebug : false), //Do not allow debug print statements if using Hardware Serial (pins 0,1) for ST Communications + _lastPingMS(0xFFFFFF00), + _lastShieldMS(0xFFFFFF00), + _networkState(STATE_UNKNOWN), + _nBufRX(0) +{ + //Removed for now to save SRAM space - Not sure why ST included this as it is never used in the library + //uint_fast8_t i = shieldType.length(); + //if (i > 32) + // i = 32; + //_shieldTypeLen = i; + + //while (i--) + //{ + // _shieldTypeBuf[i] = (uint8_t)shieldType[i]; + //} + + st_begin(2400); +} + +//***************************************************************************** +//SmartThings::~SmartThings() +SmartThings::~SmartThings() +{ +} + +//***************************************************************************** +void SmartThings::run(void) +{ + uint8_t readByte; + + while ((_nBufRX < SMARTTHINGS_RX_BUFFER_SIZE) && st_available()) + { + + readByte = st_read(); + + if ((readByte == 0x0D) || (readByte == 0x0A)) + { // handle data from SmartThing Hub line-by-line, execute user's callback function for each line + handleLine(); + } + else + { + // keep track of everything that comes in until we reach a newline + // TODO(cwvh): validate bufferlength 1988-10-19 + //if (_nBufRX > 200) + // panic("too many characters!"); + _pBufRX[_nBufRX++] = readByte; + } + + } + _process(); +} + +//***************************************************************************** +void SmartThings::send(String message) +{ + // e.g. thing.print("raw 0x0 {00 00 0A 0A 62 75 74 74 6f 6e 20 64 6f 77 6e }"); + st_print(F("raw 0x0 { 00 00 0A 0A ")); + + if (_isDebugEnabled) + { + Serial.print(F("<-| raw 0x0 { 00 00 0A 0A ")); + } + + for (int i = 0; i < message.length(); i++) + { + //char c = message[i]; + + st_print(message[i], HEX); + st_print(' '); + + if (_isDebugEnabled) + { + Serial.print(message[i], HEX); + Serial.print(' '); + } + } + + st_print(F("}\nsend 0x0 1 1\n")); + + if (_isDebugEnabled) + { + Serial.print(F("}\nsend 0x0 1 1\n")); + } +} + +//***************************************************************************** +void SmartThings::shieldSetLED(uint8_t red, uint8_t green, uint8_t blue) +{ + if (red > 9) red = 9; + if (green > 9) green = 9; + if (blue > 9) blue = 9; + + st_print(F("custom rgb ")); + st_write((red + '0')); + st_print(' '); + st_write((green + '0')); + st_print(' '); + st_write((blue + '0')); + st_print(F(" \n")); + + if (_isDebugEnabled) + { + Serial.print(F(" |<~ custom rgb ")); + Serial.write(red + '0'); + Serial.print(' '); + Serial.write(green + '0'); + Serial.print(' '); + Serial.write(blue + '0'); + Serial.print(F(" \n")); + } +} + + +//***************************************************************************** +SmartThingsNetworkState_t SmartThings::shieldGetLastNetworkState(void) +{ + return _networkState; +} + +//***************************************************************************** +SmartThingsNetworkState_t SmartThings::shieldGetNetworkState(void) +{ + _shieldGetNetworkInfo(); + return _networkState; +} + +//***************************************************************************** +uint16_t SmartThings::shieldGetNodeID(void) +{ + _shieldGetNetworkInfo(); + return _nodeID; +} + +//***************************************************************************** +void SmartThings::shieldGetEUI64(uint8_t eui[8]) +{ + _shieldGetNetworkInfo(); + { + uint_fast8_t i = 7; + do + { + eui[i] = _eui64[i]; + } while (i--); + } +} + +//***************************************************************************** +void SmartThings::shieldFindNetwork(void) +{ + st_print(F("custom find\n")); + + if (_isDebugEnabled) + { + Serial.print(F(" |<~ custom find\n")); + + } +} + +//***************************************************************************** +void SmartThings::shieldLeaveNetwork(void) +{ + st_print(F("custom leave\n")); + + + if (_isDebugEnabled) + { + Serial.print(F(" |<~ custom leave\n")); + } +} + +//***************************************************************************** +void SmartThings::st_begin(long baudRate) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + _mySerial.begin(baudRate); +#endif + case HW_SERIAL: + Serial.end(); + Serial.begin(baudRate); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + Serial1.end(); + Serial1.begin(baudRate); + break; + case HW_SERIAL2: + Serial2.end(); + Serial2.begin(baudRate); + break; + case HW_SERIAL3: + Serial3.end(); + Serial3.begin(baudRate); + break; +#endif + } +} +//***************************************************************************** +int SmartThings::st_available() +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.available(); +#endif + case HW_SERIAL: + return Serial.available(); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.available(); + break; + case HW_SERIAL2: + return Serial2.available(); + break; + case HW_SERIAL3: + return Serial3.available(); + break; +#endif + default: + return 0; + } +} +//***************************************************************************** +int SmartThings::st_read() +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.read(); +#endif + case HW_SERIAL: + return Serial.read(); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.read(); + break; + case HW_SERIAL2: + return Serial2.read(); + break; + case HW_SERIAL3: + return Serial3.read(); + break; +#endif + default: + return 0; + } +} +//***************************************************************************** +long SmartThings::st_print(String str) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.print(str); +#endif + case HW_SERIAL: + return Serial.print(str); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.print(str); + break; + case HW_SERIAL2: + return Serial2.print(str); + break; + case HW_SERIAL3: + return Serial3.print(str); + break; +#endif + default: + return 0; + } +} + +//***************************************************************************** +long SmartThings::st_print(char c) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.print(c); +#endif + case HW_SERIAL: + return Serial.print(c); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.print(c); + break; + case HW_SERIAL2: + return Serial2.print(c); + break; + case HW_SERIAL3: + return Serial3.print(c); + break; +#endif + default: + return 0; + + } +} + +//***************************************************************************** +long SmartThings::st_print(char c, int i) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.print(c, i); +#endif + case HW_SERIAL: + return Serial.print(c, i); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.print(c, i); + break; + case HW_SERIAL2: + return Serial2.print(c, i); + break; + case HW_SERIAL3: + return Serial3.print(c, i); + break; +#endif + default: + return 0; + } +} + +//***************************************************************************** +byte SmartThings::st_write(uint8_t i) +{ + switch (_SerialPort) { +#ifndef DISABLE_SOFTWARESERIAL + case SW_SERIAL: + return _mySerial.write(i); +#endif + case HW_SERIAL: + return Serial.write(i); + break; +#if BOARD_TYPE == BOARD_TYPE_MEGA + case HW_SERIAL1: + return Serial1.write(i); + break; + case HW_SERIAL2: + return Serial2.write(i); + break; + case HW_SERIAL3: + return Serial3.write(i); + break; +#endif + default: + return 0; + } +} + diff --git a/Arduino/libraries/SmartThings/.svn/wc.db b/Arduino/libraries/SmartThings/.svn/wc.db new file mode 100644 index 0000000000000000000000000000000000000000..0867c15b285ed3ecfca4ae469c5ba6acbad16989 GIT binary patch literal 118784 zcmeI5Yit|Yb$~gNMT)W{+Uu3aTF3FIc49GpXokb#V>j-GlEyY8nzTu3We2+$3}^00 zT=StNN0z;m7EOv4O@jgn`Xfn!q6u0Q zMIRfWJ$D|Q8A`M%XE&|Ahr1$&_i^qy-#zzrhNLUE3w4ulM!VBgO->9Q3o%USGaMHR zg_hy(4E(u|lW=jweFLuy{Q2{JS^dl9(B&UaOwhuy_i5sM?ETqaoh{7#*6i7t)#;U) z6Vbn%o{p-M{~7s{$!|qg!b_1C$8Us>jQs=iZRV}Ml;`O}I~AE*SeWe1-LI3~Vrf;b zD9gEu>|L#tkY+LcCIQyWT$G`3aC^j0t>Zk&v;ahB=L z*IPPykXLN;Z{_+ZScgHrxGLY_f(5uz(e46n(NgOYx2<+a%XHhj)Q2AbV)n%d%d*T@ zZkuYYL9Ax1r#VM{HMd-lU1?x~Z6}v6R^{t*88WI|alKIB%JMbn&Ekq&;Wk#vB}iVZ z>+wraBWNmDmG3|mry9+7neUTHGlPnAR&AQzA=~XPCEl;)Q=ly0Dpm5;Qu%IQ3A?-n z+b83Gy<2aCTR7HO4R%PEv@~Kj6;QOz-n&olRnTDrj43 zYZJ8XkOORVGj$cFQ0w6{$IVoC%&m5Z=F%Rcx|$ue)onl>UFp`}4nki{4Fng6{Le>!J zzSV#QK>@AX)_Z5f2$nOS?A2a~u%}Nmk4{@|zOkYdN-Jy5%ZY%iJBi#PG%?KCpXlv+ zz2goxrz`y)4@TVshz)X|G{6`3jipujT5i2izLJ&+p-D2Y(dwvyj>(x@e2sLlQtWEXbZFlb3 zecvBVwDM}&slFNXkjv7rmFJ*YTx++CMqM+NcEg$YscZF9TV&Vslzu857xmVrmqR7Ptnnt% ze2(RHiC55sxsy(|zLX9jN?$Vgq3Y!gB)cmQs7gADyO`L;{bLDy_n-x*K@9WowL109 zt*59K7(WNC2-e_{ro(Lh+_1sp^Att!y_xCVj7HcqXPCXF<#n#T?(0;*-`rHo*#@BX zXCj}vcKZmdaLwug;MVuiH6AVlxx#h~OT=j-MTA~hw^gkStJb=7 zrxkw?ja`Q@Xi#t28 zVZJpUW-nf3?pnm0Jx!OqwL`b0189r~#J(Pa z|M7tYkN^@u0!RP}AOR$R1dsp{Kmter3H%=uc#Sy{s;_UE=63hxrKQcfxwTWf0@3rO zRkc+ojnZbjqisP5eyLJba;=Bv7DPmi1fR~PlImriB-G0yuN#-MDz9JGh?K6S^;)`S z7*k*u6Z>We{>KLrKmter2_OL^fCP{L5%Ad)7jx}H*#*;I;MbEF%5 zMog#0v?1vNpCY2f6Cst!CJo-m*0TKTNBq)LVph^>f>skrCJXB8Mor5YNg`xw(2~ka zYDP+t3_1QITY8qyWHm9H=96ioR;wAhniMERQAqP7D<I&f>#C${LXto)Nzk`qQs;S5$O>8} z31%c;XZ+Ijq?QoUVzwqE^pqj0Qif1((X$EgpR^`wysl<>At}FSOBd2AFNnI%>v}pX zB+_D%Pi7LDno(7v^GSo=|BuYR7m97g#%8}Y`(8|neKq#YpT^0tE)qZjNB{{S0VIF~ zkN^@u0!RP}Ac4aXNQ~E+!-YyBUX@YfA7NjW5rY~NUX@WJ6-T@(qlO>Gy(*)I6vpW9 z|JlSwjT6xO|Dj`t>lZAI1dsp{Kmter2_OL^fCP{L51nB*LJpVsieTLd1 z0VIF~kN^@u0!RP}AOR$R1dsp{I4l7?{~wkZmPZ0e00|%gB!C2v01`j~NB{{S0VMG3 z5y12Rv)5;+F%m!mNB{{S0VIF~kN^@u0!RP}Ac4aY!0-PbmKc^t0!RP}AOR$R1dsp{ zKmter2_OL^@az%5`~S~gpP|M`00|%gB!C2v01`j~NB{{S0VIF~4okqj{~!B(`0vqS zYh!sNfCP{L5n^RfA3UU~ zoWSv%0KztUSFB=iStti9+#?Tn+a0}o#e87eEQMzOdgiyM-#Pl5Q#Yd5B0J%qpLlJo$}EjH4)Up$ETSN~|Sd%yMauJ&?ARdn_K z%lApATW_~6?{pemCd)0Ys;xR{ls4NPZL6)_TdGu*T6SeRj;N>kRFW5XQPdI%HIYizQi-gp)zYFWCTgOT6yZ9p z4Z?|jZxlGv2MfnFB;H#)ekwXM8H!dYm=nj&gsAs~LcLmO1RyR4z1~@jgUouXZay3| z@G*U!PJN(e!N-f3)BDE)So8m9EIfwBhdKg!WY#wVd>w6u$OE;x-5}i&I(*43dtlF} z2FCs4Y#r61rQ}GX-PJ3;mz=2nrI@FBH(6;m~L zx~`1Fa2O)$r^O@inGr|EA^8l^H~y$N{Zh2YOs++H`QQ|}_qiu=8zS=xEHp0CAw@m_ z(nBQE#@$ZvFJWRWozM&;mFD?`AsK}5*;*!<)zp+gBu!FvJ*6hIsnnn=vuh*F(t`LQ zdG!z@ha^+mIMm9y14Ig%8um<9n|~=c89A zB&xd@+iYr^ActoJWL7=jd zo=gA;33k(BEm5nbbiV5(EW9@s;G}JDAC?qUIf#{>)Dl8k%+`d2o-#yL$`E=&)3XUUv!yjr<8?L53&}xN z@_VDON{r}JPr(Z8iBHA;J2XA}-O%iJW8aVcRqW4VzZd&j?3ZJ$*o|0t_CIF7{}DLT zqlriW2_OL^fCP{L5g2*dsDN#^(q6L6b~@!xMfHah_~C>i(0Tr3x+ z;dsW4&JGFn4oRk=%;`@|z37Gl#1jI-ON_nxq=!+8&L>|bVvQ>3en>{fBK_Dg& z8k(4zfC!`!CA5&PZP+t0cSp#Dez2_OL^fCP{L5de&Vj~0)0CjT~Coytya&77Yp&HTaaAICoVq0{TV#6;MI1*Z3| zsn!~#EZ-_s^3_uLu6H%IQkHX7nXBfO3o_@WbBi3u)pagktjgErGIy(-znLrF<<{i8 zTyDKu$`_&HO}SXT1m!yIw#ji-`A(HvFXnHr%UrQk<%;Wt0?pmo0XcTAn+&OOaV*SU zUtr(^?K*kTeXCJ7iK6b9ZR@?_X`%?;_4uvvFnjSLbJw!RsnjKJ?U0s62HqYCST>Nk z*ixJ164Z>Z9tpGa3(OlJ#d)<=!DrZyC{*4b%x!ZBG|8!%4CGS2x>+gW`)v9uAt-OA za$D_?mZ<~^(0bdQ_BQF5@a-IqTP~EAX`0q<8I8JTD(!|d_5-OcvTOHHAeDZ!9lko_ z`sc&vQMKzxvbBk6NUkdhH9N@>L=`fo=H_YFBo}vi8H#2X}z_>og z^iDYA+R3|>1AnRd3eGx?=Z@+?IXbF+W&2tNy(hjo8(~FgYa-az%8gv{x?F(q?voKa zxIM4zzBaYKkHq(;Vi9(3j(N0e4JDX?*681{z~CvAaH;HX0&uCsrPAK%*|Re)mAF*G z*I(%hic6)v3;Refl`Cu32D3x9+ubMbF}+g|x9IFM?TUeIWMHce`_Oxe*}g|$Z*H9_ z{hLrLv%T9Q9dAEprNNfI3ER_wRB&5wLr zpwGu=!e0-?#xtSF`;%`+mFTZbe|CCj`nxm#I9rH)GWxdPevKmtg>N1)d| z3rB#n%%cV82ms+Dxm?T@D$1&S4UYQ|a&Z#QIGgo>XhJ{Vtw7HK{lxys14jK*Jal3x zffF&EJ)Y(f5E5^EJi-cRncmz!qwQl>U;U2_9D4d0ie2zvTL(^Ak6!y&ggtwf`O+^~ zho8QT{>4jyV^BZ&XBa^UO#SYJ{P?)V0c#44=Fk}60V@WC6b8eOv@7@ZZ@+K%tvR%4 zV1amiQ5p?VO$aSPysbm-*X<}1mFl+ZrS>Jkg+v_j|*qQtbBIZ>eTN?Md)9` zk7R_7>=jN&PG4syzaX0sfY>CRR$C`sWoMhNll>ru;?Hy)q@2G__8&~>S`HJNNrNXM0wk%)I7XgVQX}bf_o_dRL6}bva zwG)ZE>Rn!hf3b(7vdgm9=G8zuuN*?$<%7lfReXh$i>vP(x5MkQHM%xR z^@5Af3a@+V)&TRz=lq?%FTPF#WA^5|KU%<=c(3+Cggt$ld34%te?_4ik`4RiM6hK$ z@v-CjiJ?LG=5sLm*Vl$RHr<60U1^Z}qydq@eSt@q)N|{FDtB3+rTz8>16jUSU?Ud4 zd?L)|P7m{R$5CtreBa( zAOsEbsoL=55BG8B@N}lI2!CmDRo#HohcNX2`_+Zt9Rd@fBEv=Qf zV&4F{%C(%U{YCARTyd3y;(=`%DA5Y0#I;kAxrK$v-kb+wIaiTw3iN6}0-8G9{sRo> zdmHnS(-J!gH@^JqGyJ1=aD(N^%W|-svl{1%6}fEPZ+yZEOz+onAIi!LOJ#54rGqTf zNrS-7!*8uSPX{&}!E%metKe01pApzw_!nu;*;_o7WutBa+<*ViceKGvB!C2v01`j~ zNB{{S0VIF~kN^@u0!ZLFBjEn~f6tj&XbuuU0!RP}AOR$R1dsp{Kmter2_OL^;3I(N ze;*9IL;^?v2_OL^fCP{L5 Date: Wed, 13 May 2015 22:31:03 -0500 Subject: [PATCH 06/15] Update README.md updated pic on wiring AD2Pi --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc11f6e..0d78158 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ Pin Configuration for AD2Pi to Arduino Mega - From d6f2b968f4eb68a932ca16f9eb82bb0febef1915 Mon Sep 17 00:00:00 2001 From: Stan Date: Wed, 13 May 2015 22:37:01 -0500 Subject: [PATCH 07/15] Update README.md updated hardware pics --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0d78158..1008e55 100644 --- a/README.md +++ b/README.md @@ -79,10 +79,12 @@ The shield has a DIP switch that allows it to either read serial commands via pi Before stacking the ThingShield on top of the ArduinoMega, bend the pin0 and pin1 of the ThingShield out to a 45 degree angle so they do not insert into the Arduino Mega. (Geek's Note: This prevents the ThingShield from recieving messages from Serial0 of the Mega which normally go out pin0 and pin1. Instead, we will redirect serial communication from Serial1 to the ThingShield using jumpers). See pictures. - + - + + + Note, the ThingShield pins are not labeled. So you can identify the pins using labels on the ArduinoMega picture (above). From 3d02a01a1d0a35a3ac5671507c8a03e38401b010 Mon Sep 17 00:00:00 2001 From: Stan Date: Sun, 17 May 2015 19:13:58 -0500 Subject: [PATCH 08/15] Update README.md Near final README for version 3.0 --- README.md | 45 ++++++++++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 1008e55..9c08ecd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## AD2SmartThings v2.0 +## AD2SmartThings v3.0 ### =================== ### Integrate your Honeywell or Ademco alarm panel into your SmartThings physical graph ADT / Honeywell / Ademco / Vista / Alarm / SmartThings / Alarm Panel / Home Alarm @@ -13,6 +13,9 @@ After installing this project, you can control your alarm panel automagically!!! * Control your alarm panel via a MiniMote or activate from other sensors or devices +Date: May 17, 2015 +This is Version 3.0 release. This release standardizes the hardware assembly of the AD2SmartThings device which addresses the top two support issues. The release does not add any additional capabilities and uses the same device type. If you already completed the project, I don't see any reason to update. However, if you still want to update, you simply reconfigure your hardware and update the Arduino sketch being sure to include the ST_Anything SmartThings library. The libraries from SmartThings and the library used in versions 1 & 2 are no longer compatible with the sketch. A big thanks to Daniel Ogorchock and his son, Daniel Ogorchock, for creating a superior version of the SmartThings library with many enhancements and full support for the Arduino Mega. + Date: Feb 8, 2015 This is Version 2.0 release. To use this release you have to install or update both the Device Type v2.0 and the Arduino Sketch 2.0. This release is not backwards compatable with V1.X code. @@ -21,8 +24,8 @@ This is Version 2.0 release. To use this release you have to install or update 1. Order the hardware 2. Add SmartThings hub to your home network, download app to your iPhone 3. Obtain a Maker/Developer account for SmartThings (graph.api.smartthings.com) -4. Assemble the Arduino Mega, ThingShield and AD2Pi -5. Download the Arduino developer environment and import the AD2SmartThings sketch as well as the required libraries, including the SmartThingsMega and the Timer library. +4. Assemble the Arduino Mega, ThingShield and AD2Pi. Power up. +5. Download the Arduino developer environment and import the AD2SmartThings sketch as well as the required libraries, including the SmartThing (ST_Anything version) and the Timer library. Load the sketch to the ArduinoMega. 6. Add ArduinoMega/ThingShield to your SmartThings hub using your iPhone app 7. Go to graph.api.smartthings.com 1. On My Device Types, create a new device type and paste in the device type code. Save & Publish @@ -31,6 +34,7 @@ This is Version 2.0 release. To use this release you have to install or update 9. Thoroughly test out system! No Warranty (see license terms). ## The Hardware List + The AD2Pi was obtained from Alarm Decoder. www.alarmdecoder.com All other items from this project were easily obtained from Amazon via Amazon Prime @@ -40,6 +44,7 @@ All other items from this project were easily obtained from Amazon via Amazon Pr * Jumper wires * 9V power adapter + ### An ArduinoMega, SmartThing ThingShield and AD2Pi @@ -57,7 +62,7 @@ For the wiring, I used individual male to male jumper cables to wire the project ### Power Supplies -For a power supply to power up the ArduinoMega I used a 9V power supply to run the Arduino+ThingShield. This was purchased at Amazon as well by searching for "Arduino Power Supply". Right now, I am using the Super Power Supply® AC / DC Adapter Charger Cord Plug - 9V 650mA compatible with Arduino Freeduino Duemilanove Uno Mega Hobby Electronics, which was available by Amazon Prime. CAUTION: There are 9V power supplies availble on Amazon that do not work for the Arduino (they are made for musical instrament controllers) and some that perform very poorly on Arduino. Be sure to read the reviews! +To power the ArduinoMega I used a 9V power supply to run the Arduino+ThingShield. This was purchased at Amazon as well by searching for "Arduino Power Supply". Right now, I am using the Super Power Supply® AC / DC Adapter Charger Cord Plug - 9V 650mA compatible with Arduino Freeduino Duemilanove Uno Mega Hobby Electronics, which was available by Amazon Prime. CAUTION: There are 9V power supplies availble on Amazon that do not work for the Arduino (they are made for musical instrament controllers) and some that perform very poorly on Arduino. Be sure to read the reviews on Amazon to find an Arduino compatable power supply! ### Project Housing I simply strapped the Arduino onto a foam board and inserted it into my alarm panel box @@ -72,22 +77,23 @@ I simply strapped the Arduino onto a foam board and inserted it into my alarm pa An **Arduino Mega* was used as the controller and was stacked with the SmartThings ThingShield. -*Set the DIP switch on the ThingShield to D0/D1.* -The shield has a DIP switch that allows it to either read serial commands via pins 0/1 or pins 2/3. For this project, the ThingShield is reading the Serial commands from the ArduinoMega through the ThingShield pins 0/1. Check that the DIP switch is set to D0/D1. - - - -Before stacking the ThingShield on top of the ArduinoMega, bend the pin0 and pin1 of the ThingShield out to a 45 degree angle so they do not insert into the Arduino Mega. (Geek's Note: This prevents the ThingShield from recieving messages from Serial0 of the Mega which normally go out pin0 and pin1. Instead, we will redirect serial communication from Serial1 to the ThingShield using jumpers). See pictures. +*Set the DIP switch on the ThingShield to D2/D3.* +The shield has a DIP switch that allows it to either read serial commands via pins 0/1 or pins 2/3. For this project, the ThingShield is reading the Serial commands from the ArduinoMega through the ThingShield pins 2/3. Check that the DIP switch is set to D2/D3. Note, this is typically the default position when ThingShields are manufactured. - + +Stack the ThingShield on top of the Arduino Mega, matching the pins as you push the two boards together. All pins should be securely contacted. - +Use jumpers to provide a connection between Serial3 and Pins 2/3. Here are the connections: + *Jumper Pin Pin + *RX 14 2 + *TX 15 3 - + + -Note, the ThingShield pins are not labeled. So you can identify the pins using labels on the ArduinoMega picture (above). +Note, the ThingShield pins are not labeled. So you can identify the pins using labels on the ArduinoMega picture (above) or by study the photos of my project (above). 7. Connect the Arduino to USB power or to a 9V power supply using the appropriate ports. 8. When not using the USB power supply, place a piece of black electrical tape over the USB port to prevent accidental shorting @@ -106,13 +112,13 @@ Pin Configuration for AD2Pi to Arduino Mega - ### Wiring The AD2Pi to your Honeywell or Ademco alarm panel -There is excellent documentation on the Alarm Decoder web site, including an instructional video. The wiring is the same for the AD2Pi as the AD2USB. +There is excellent documentation on the Alarm Decoder web site, including an instructional video. Look for instructions on how to wire the AD2USB which are the same instructions for the AD2Pi used in this project. Here is the URL: http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration @@ -131,12 +137,12 @@ http://arduino.cc/en/main/software Once the software is installed, the first thing to do is obtain the required libraries. * Timer library was created by Simon Monk as modified by JChristensen. A copy is included in this repository/release for your convenience. -* SmartThings Mega library contained in this repository/release +* A copy of the SmartThings library contained in this repository/release. This is the ST_Anything version of the SmartThings library. The libraries from SmartThings and the SmartThingsMega libraries do not work. * SoftwareSerial library was default library provided with Arduino IDE -Once you have the zip files downloaded you can import them within the Arduino IDE. Go to the Sketch:Import Library;Add Library drop down menu. Once you have added the libraries, they will show up under Sketch:Add Library:Contributed as "Timer" and "SmartThingsMega". Be sure the Timer library is installed named as "Timer" +Once you have the zip files downloaded you can import them within the Arduino IDE. Go to the Sketch:Import Library;Add Library drop down menu. Once you have added the libraries, they will show up under Sketch:Add Library:Contributed as "Timer" and "SmartThings". Be sure the Timer library is installed and named: "Timer" -You can connect the Arduino Uno to your computer via an USB cable, create a new sketch, paste the code from github into the Arduino IDE and then transfer to the ArduinoMEGA. Be sure to go to the tools menu, select and then select the ArduinoMega 2560 so that the code will compile correctly and not time out during transfer. +You can connect the Arduino Mega to your computer via an USB cable, create a new sketch, paste the code from github into the Arduino IDE and then transfer to the ArduinoMEGA. Be sure to go to the tools menu, select and then select the ArduinoMega 2560 so that the code will compile correctly and not time out during transfer. Pairing instructions for the Arduino to the SmartThings hub can be found at SmartThings.com and are copied here: @@ -238,3 +244,4 @@ Have fun integrating! * Thanks to authors: Vassilis Varveropoulos, Brice Dobry for the ArduinoMega ThingShield library and intial ideas * Lots of good ideas from SmartThings @craig * Thanks to Sean Matthews from AlarmDecoder for jumping in to help out with configuring device address, setting up Panic codes, and other help. +* A big thanks to Daniel Ogorchock and his son, Daniel Ogorchock, for many enhancements to the SmartThings library, including full support for the Arduino Mega. From d0a94b392364678a81dbbd8662d19400db30093e Mon Sep 17 00:00:00 2001 From: Stan Date: Sun, 17 May 2015 19:16:35 -0500 Subject: [PATCH 09/15] Update README.md formatting enhancements --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9c08ecd..e0e0c03 100644 --- a/README.md +++ b/README.md @@ -85,9 +85,10 @@ The shield has a DIP switch that allows it to either read serial commands via pi Stack the ThingShield on top of the Arduino Mega, matching the pins as you push the two boards together. All pins should be securely contacted. Use jumpers to provide a connection between Serial3 and Pins 2/3. Here are the connections: - *Jumper Pin Pin - *RX 14 2 - *TX 15 3 + + * Jumper Pin Pin + * RX 14 2 + * TX 15 3 @@ -103,11 +104,12 @@ Note, the ThingShield pins are not labeled. So you can identify the pins using Here are the pin connections to make between the Arduino/Thingshield and the AD2Pi along with a couple pics to get you oriented. You can make these connections using an 8" male to male jumper wire. Pin Configuration for AD2Pi to Arduino Mega - * Jumper AD2PI Mega - * 3.3V 1 3.3V - * GND 6 GND - * TX 8 18 - * RX 10 19 + + * Jumper AD2PI Mega + * 3.3V 1 3.3V + * GND 6 GND + * TX 8 18 + * RX 10 19 Date: Tue, 26 May 2015 19:39:43 -0500 Subject: [PATCH 10/15] Update README.md a few more edits for readability --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e0e0c03..b572bee 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,22 @@ ### Integrate your Honeywell or Ademco alarm panel into your SmartThings physical graph ADT / Honeywell / Ademco / Vista / Alarm / SmartThings / Alarm Panel / Home Alarm -Do you have a home alarm panel and never use it? Do you hate the hassle of remember to arm and having to run around to disarm? +Do you have a home alarm panel and want to integrate with SmartThings? Do you hate the hassle of remember to arm and having to rush to disarm? Do you want to install another keypad and don't want to deal with your alarm company? Do you have an alarm panel and never use it? This is a relatively simple integration project that effectively integrates your Honeywell or Ademco alarm panel with SmartThings. These panels are typically installed by ADT or other alarm companies. You can choose to continue or not with your ADT monitoring service. This project works either way. -After installing this project, you can control your alarm panel automagically!!!!! +After installing this project, control of your alarm panel becomes intuitive and automagic! * Have it arm automatically after everyone has left the house by integrating with your presence sensors! And have it disarm when you arrive. -* Have it turn on automatically when you go to bed and turn off automatically when you wake by integrating with your Goodnight! automation and your GoodMorning! automation +* Use automation to have your alarm automatically turn on when you go to bed and turn off when you wake up * Control your alarm panel via a MiniMote or activate from other sensors or devices +* Use your phone to send a panic alarm when something is amiss Date: May 17, 2015 -This is Version 3.0 release. This release standardizes the hardware assembly of the AD2SmartThings device which addresses the top two support issues. The release does not add any additional capabilities and uses the same device type. If you already completed the project, I don't see any reason to update. However, if you still want to update, you simply reconfigure your hardware and update the Arduino sketch being sure to include the ST_Anything SmartThings library. The libraries from SmartThings and the library used in versions 1 & 2 are no longer compatible with the sketch. A big thanks to Daniel Ogorchock and his son, Daniel Ogorchock, for creating a superior version of the SmartThings library with many enhancements and full support for the Arduino Mega. +This is Version 3.0 release. This release standardizes the hardware assembly of the AD2SmartThings device which addresses the top two support issues. The release does not add any additional capabilities to Version 2.0 and uses the same Device Type. If you already updated to Version 2.0 or recently completed the project, I don't see any reason to update. However, if you still want to update, you simply reconfigure your hardware and update the Arduino sketch being sure to include the ST_Anything SmartThings library. The libraries from SmartThings and the ArduinoMega library used in versions 1 & 2 are not compatible with this Version 3.0 sketch. You must use the ST_Anything SmartThings library. A big thanks to Daniel Ogorchock and his son, Daniel Ogorchock, for creating a superior version of the SmartThings library with many enhancements and full support for the Arduino Mega. Date: Feb 8, 2015 -This is Version 2.0 release. To use this release you have to install or update both the Device Type v2.0 and the Arduino Sketch 2.0. This release is not backwards compatable with V1.X code. +This is Version 2.0 release. To use this release you have to install or update both the Device Type v2.0 and the Arduino Sketch 2.0. This release is not backwards compatable with the Version 1.X device type. ## High Level Project Steps @@ -25,7 +26,7 @@ This is Version 2.0 release. To use this release you have to install or update 2. Add SmartThings hub to your home network, download app to your iPhone 3. Obtain a Maker/Developer account for SmartThings (graph.api.smartthings.com) 4. Assemble the Arduino Mega, ThingShield and AD2Pi. Power up. -5. Download the Arduino developer environment and import the AD2SmartThings sketch as well as the required libraries, including the SmartThing (ST_Anything version) and the Timer library. Load the sketch to the ArduinoMega. +5. Download the Arduino developer environment and import the AD2SmartThings sketch as well as the required libraries, including the SmartThing (ST_Anything version) and the Timer library. Transfer the sketch to the ArduinoMega over USB. 6. Add ArduinoMega/ThingShield to your SmartThings hub using your iPhone app 7. Go to graph.api.smartthings.com 1. On My Device Types, create a new device type and paste in the device type code. Save & Publish @@ -78,7 +79,7 @@ I simply strapped the Arduino onto a foam board and inserted it into my alarm pa An **Arduino Mega* was used as the controller and was stacked with the SmartThings ThingShield. *Set the DIP switch on the ThingShield to D2/D3.* -The shield has a DIP switch that allows it to either read serial commands via pins 0/1 or pins 2/3. For this project, the ThingShield is reading the Serial commands from the ArduinoMega through the ThingShield pins 2/3. Check that the DIP switch is set to D2/D3. Note, this is typically the default position when ThingShields are manufactured. +The shield has a DIP switch that allows it to either read serial commands via pins 0/1 or pins 2/3. For this project, the ThingShield is reading the Serial commands from the ArduinoMega through the ThingShield pins 2/3. Check that the DIP switch is set to D2/D3. Note, this is typically the default position when ThingShields are shipped. @@ -126,7 +127,7 @@ http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration ## The Software -The code for this project is in a few files which are posted on github: +The code for this project can be found posted on github: https://github.com/d8adrvn/ad2smartthings.git From 70313b856956dc19003b525a987c1d00b1275235 Mon Sep 17 00:00:00 2001 From: Stan Date: Wed, 27 May 2015 16:48:10 -0700 Subject: [PATCH 11/15] Update README.md --- README.md | 48 ++++++++++++++++++++---------------------------- 1 file changed, 20 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index b572bee..1d4a76c 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,21 @@ -## AD2SmartThings v3.0 +## AD2SmartThings v2.1 ### =================== ### Integrate your Honeywell or Ademco alarm panel into your SmartThings physical graph ADT / Honeywell / Ademco / Vista / Alarm / SmartThings / Alarm Panel / Home Alarm -Do you have a home alarm panel and want to integrate with SmartThings? Do you hate the hassle of remember to arm and having to rush to disarm? Do you want to install another keypad and don't want to deal with your alarm company? Do you have an alarm panel and never use it? +Do want to integrate your home alarm panel with SmartThings? Do you hate the hassle arming your panle and having to rush to disarm? Do you want to install another keypad and don't want to deal with your alarm company? Do you have an alarm panel and never use it? This is a relatively simple integration project that effectively integrates your Honeywell or Ademco alarm panel with SmartThings. These panels are typically installed by ADT or other alarm companies. You can choose to continue or not with your ADT monitoring service. This project works either way. After installing this project, control of your alarm panel becomes intuitive and automagic! -* Have it arm automatically after everyone has left the house by integrating with your presence sensors! And have it disarm when you arrive. -* Use automation to have your alarm automatically turn on when you go to bed and turn off when you wake up -* Control your alarm panel via a MiniMote or activate from other sensors or devices -* Use your phone to send a panic alarm when something is amiss +* Automatically arm your panel after everyone has left the house, and have it disarm when you arrive. +* Use automation to turn on your alarm when you go to bed and turn off when you wake up +* Control your alarm panel via your smartphone or a MiniMote or activate from other sensors or devices +* Use your smartphone or Minimote to send a panic alarm when there is danger. Date: May 17, 2015 -This is Version 3.0 release. This release standardizes the hardware assembly of the AD2SmartThings device which addresses the top two support issues. The release does not add any additional capabilities to Version 2.0 and uses the same Device Type. If you already updated to Version 2.0 or recently completed the project, I don't see any reason to update. However, if you still want to update, you simply reconfigure your hardware and update the Arduino sketch being sure to include the ST_Anything SmartThings library. The libraries from SmartThings and the ArduinoMega library used in versions 1 & 2 are not compatible with this Version 3.0 sketch. You must use the ST_Anything SmartThings library. A big thanks to Daniel Ogorchock and his son, Daniel Ogorchock, for creating a superior version of the SmartThings library with many enhancements and full support for the Arduino Mega. - -Date: Feb 8, 2015 -This is Version 2.0 release. To use this release you have to install or update both the Device Type v2.0 and the Arduino Sketch 2.0. This release is not backwards compatable with the Version 1.X device type. +This is Version 2.1 release. This release standardizes the hardware assembly of the AD2SmartThings device, which addresses the top two support issues. The release includes a new Version 2.1 of the Arduino sketch and a new README with updated project instructions. The release does not add any additional capabilities to Version 2.0 and uses the same Device Type. If you already updated to Version 2.0 or recently completed the project, I don't see any reason to update. However, if you still want to update, you simply reconfigure your hardware and update the Arduino sketch being sure to include the ST_Anything SmartThings library. The libraries from SmartThings and the ArduinoMega library are not compatable with this Version 2.1 sketch. You must use the ST_Anything SmartThings library. A big thanks to Daniel Ogorchock and his son, Daniel Ogorchock, for creating a superior version of the SmartThings library with many enhancements and full support for the Arduino Mega. This release is not backwards compatable with the Version 1.X device type. ## High Level Project Steps @@ -32,7 +29,8 @@ This is Version 2.0 release. To use this release you have to install or update 1. On My Device Types, create a new device type and paste in the device type code. Save & Publish 8. Go to My Devices, select the newly added Arduino and edit the Device Type and select the HomeAlarm device type (step 7.i.) 9. Configure preferences on your mobile device. -9. Thoroughly test out system! No Warranty (see license terms). +10. Connect your project to your alarm panel. +11. Thoroughly test out system! No Warranty (see license terms). ## The Hardware List @@ -68,11 +66,7 @@ To power the ArduinoMega I used a 9V power supply to run the Arduino+ThingShield ### Project Housing I simply strapped the Arduino onto a foam board and inserted it into my alarm panel box - -### Wiring the Project - -* Wiring diagrams are included in the header of the Arduino sketch. - +## Constructing Your Project ### Wiring The Arduino Controller and Configuring The ThingShield @@ -97,9 +91,6 @@ Use jumpers to provide a connection between Serial3 and Pins 2/3. Here are the Note, the ThingShield pins are not labeled. So you can identify the pins using labels on the ArduinoMega picture (above) or by study the photos of my project (above). -7. Connect the Arduino to USB power or to a 9V power supply using the appropriate ports. -8. When not using the USB power supply, place a piece of black electrical tape over the USB port to prevent accidental shorting - ### Wiring the AD2Pi to the Arduino/ThingShield Here are the pin connections to make between the Arduino/Thingshield and the AD2Pi along with a couple pics to get you oriented. You can make these connections using an 8" male to male jumper wire. @@ -118,13 +109,6 @@ Pin Configuration for AD2Pi to Arduino Mega - -### Wiring The AD2Pi to your Honeywell or Ademco alarm panel - -There is excellent documentation on the Alarm Decoder web site, including an instructional video. Look for instructions on how to wire the AD2USB which are the same instructions for the AD2Pi used in this project. Here is the URL: - -http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration - ## The Software The code for this project can be found posted on github: @@ -205,10 +189,18 @@ To install the device type code: 10. Select your Arduino and using the drop down, select your newly created AD2SmartThings device type (v2 or later). 11. Go to your mobile device and the Arduino tile should now display as a Home Alarm tile. Hint: on the iPhone, sometimes you have to kill the SmartThings app two times before a new device type update will display on the SmartThings iPhone app. -## Configuring Your System To Work With Vista10SE or other SE-series +## Connect Your Project To Your Alarm Panel + +### Wiring The AD2Pi to your Honeywell or Ademco alarm panel + +There is excellent documentation on the Alarm Decoder web site, including an instructional video. Look for instructions on how to wire the AD2USB which are the same instructions for the AD2Pi used in this project. Here is the URL: + +http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration + +### Configuring Your System To Work With Vista10SE or other SE-series The VistaSE series requires the AD2Pi to be configured with an ADDRESS=31. To do this, go to the Preferences tile on your mobile device and in the Configuration box, enter "ADDRESS=31". All caps, no spaces and no quotes. After entering this in the Preferences, you must then press the Config AD2Pi tile to send down the configuration command to the AD2Pi. You will see the Message tile indicate !Sending and then you should see a confirmation message of "ADDRESS=31". You can double check your work by going back to the Preferences, erasing the command (recommended) and then pressing the ConfigAD2Pi tile once again. The Message tile will report back the current address of the AD2Pi. -## Configuring Your System To Work With Vista 20P or other P-series +### Configuring Your System To Work With Vista 20P or other P-series The Vista20P will only commuicate to the AD2Pi if it has been properly configured with a unique address. This requires two steps. First, you need to activate an unused keypad address in your Vista20P and second, you need to configure the AD2Pi with that address. To configure your Vista20P, follow the instructions in the manual to activate an unused keypad address. There is a helpful video at alarmdecoder.com http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration You can also find a manual at http://site.aesecurity.com/Manuals/v15pand20pprogrammingguide.pdf From 7f59c583d45f6e0459254f9c3f6b8770cf528d09 Mon Sep 17 00:00:00 2001 From: Stan Date: Wed, 27 May 2015 22:01:30 -0500 Subject: [PATCH 12/15] Update README.md Added additional pic and table formatting. --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1d4a76c..80751cc 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ All other items from this project were easily obtained from Amazon via Amazon Pr -### Wiring +### Jumpers For the wiring, I used individual male to male jumper cables to wire the project (see below). I found these at Amazon such as **Male to Male Solderless Flexible Breadboard Jumper Cable Wires 65Pcs for Arduino by Sunkee**. @@ -81,14 +81,17 @@ Stack the ThingShield on top of the Arduino Mega, matching the pins as you push Use jumpers to provide a connection between Serial3 and Pins 2/3. Here are the connections: - * Jumper Pin Pin - * RX 14 2 - * TX 15 3 + | Jumper | Pin | Pin | + | RX | 14 | 2 | + | TX | 15 | 3 | + + + Note, the ThingShield pins are not labeled. So you can identify the pins using labels on the ArduinoMega picture (above) or by study the photos of my project (above). ### Wiring the AD2Pi to the Arduino/ThingShield @@ -97,11 +100,12 @@ Here are the pin connections to make between the Arduino/Thingshield and the AD2 Pin Configuration for AD2Pi to Arduino Mega - * Jumper AD2PI Mega - * 3.3V 1 3.3V - * GND 6 GND - * TX 8 18 - * RX 10 19 +|Jumper | AD2PI | Mega | +|________|________|________| +| 3.3V | 1 | 3.3V | +| GND | 6 | GND | +| X | 8 | 18 | + | RX | 10 | 19 | Date: Wed, 27 May 2015 22:05:37 -0500 Subject: [PATCH 13/15] Update README.md worked on table formatting --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 80751cc..4baaee1 100644 --- a/README.md +++ b/README.md @@ -81,9 +81,10 @@ Stack the ThingShield on top of the Arduino Mega, matching the pins as you push Use jumpers to provide a connection between Serial3 and Pins 2/3. Here are the connections: - | Jumper | Pin | Pin | - | RX | 14 | 2 | - | TX | 15 | 3 | +| Jumper | Pin | Pin | +|________|_____|_____| +| RX | 14 | 2 | +| TX | 15 | 3 | @@ -100,12 +101,12 @@ Here are the pin connections to make between the Arduino/Thingshield and the AD2 Pin Configuration for AD2Pi to Arduino Mega -|Jumper | AD2PI | Mega | +|Jumper | AD2PI | Mega | |________|________|________| -| 3.3V | 1 | 3.3V | -| GND | 6 | GND | -| X | 8 | 18 | - | RX | 10 | 19 | +| 3.3V | 1 | 3.3V | +| GND | 6 | GND | +| X | 8 | 18 | +| RX | 10 | 19 | Date: Wed, 27 May 2015 22:12:18 -0500 Subject: [PATCH 14/15] Update README.md Ok, tables should be correctly formatted (and I learned how to use the preview tool to avoid extra commits!) --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4baaee1..118fcb1 100644 --- a/README.md +++ b/README.md @@ -81,10 +81,10 @@ Stack the ThingShield on top of the Arduino Mega, matching the pins as you push Use jumpers to provide a connection between Serial3 and Pins 2/3. Here are the connections: -| Jumper | Pin | Pin | -|________|_____|_____| -| RX | 14 | 2 | -| TX | 15 | 3 | +| Jumper | Pin | Pin | +|:--------:|:------:|:-----:| +| RX | 14 | 2 | +| TX | 15 | 3 | @@ -102,7 +102,7 @@ Here are the pin connections to make between the Arduino/Thingshield and the AD2 Pin Configuration for AD2Pi to Arduino Mega |Jumper | AD2PI | Mega | -|________|________|________| +|:--------:|:--------:|:--------:| | 3.3V | 1 | 3.3V | | GND | 6 | GND | | X | 8 | 18 | From 182680580c19a0760520b74f272a7c64ae1557ed Mon Sep 17 00:00:00 2001 From: Stan Date: Wed, 27 May 2015 22:18:42 -0500 Subject: [PATCH 15/15] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 118fcb1..6f3e3cb 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,9 @@ After installing this project, control of your alarm panel becomes intuitive and * Use your smartphone or Minimote to send a panic alarm when there is danger. -Date: May 17, 2015 -This is Version 2.1 release. This release standardizes the hardware assembly of the AD2SmartThings device, which addresses the top two support issues. The release includes a new Version 2.1 of the Arduino sketch and a new README with updated project instructions. The release does not add any additional capabilities to Version 2.0 and uses the same Device Type. If you already updated to Version 2.0 or recently completed the project, I don't see any reason to update. However, if you still want to update, you simply reconfigure your hardware and update the Arduino sketch being sure to include the ST_Anything SmartThings library. The libraries from SmartThings and the ArduinoMega library are not compatable with this Version 2.1 sketch. You must use the ST_Anything SmartThings library. A big thanks to Daniel Ogorchock and his son, Daniel Ogorchock, for creating a superior version of the SmartThings library with many enhancements and full support for the Arduino Mega. This release is not backwards compatable with the Version 1.X device type. + +***Release Note:*** +*This release standardizes the hardware assembly of the AD2SmartThings device, which addresses the top two support issues. The release includes a new Version 2.1 of the Arduino sketch and a new README with updated project instructions. The release does not add any additional capabilities to Version 2.0 and uses the same Device Type. If you already updated to Version 2.0 or recently completed the project, I don't see any reason to update. However, if you still want to update, you simply reconfigure your hardware and update the Arduino sketch being sure to include the ST_Anything SmartThings library. The libraries from SmartThings and the ArduinoMega library are not compatable with this Version 2.1 sketch. You must use the ST_Anything SmartThings library. A big thanks to Daniel Ogorchock and his son, Daniel Ogorchock, for creating a superior version of the SmartThings library with many enhancements and full support for the Arduino Mega. This release is not backwards compatable with the Version 1.X device type.* ## High Level Project Steps