Dali.h

Go to the documentation of this file.

/***********************************************************************
 * This library is free software; you can redistribute it and/or       *
 * modify it under the terms of the GNU Lesser General Public          *
 * License as published by the Free Software Foundation; either        *
 * version 2.1 of the License, or (at your option) any later version.  *
 *                                                                     *
 * This library is distributed in the hope that it will be useful,     *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU   *
 * Lesser General Public License for more details.                     *
 *                                                                     *
 * You should have received a copy of the GNU Lesser General Public    *
 * License along with this library; if not, write to the Free Software *
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
 * MA 02110-1301  USA                                                  *
 ***********************************************************************/
 
#ifndef DALI_H
#define DALI_H
 
#include <arduino.h>
#include "dalibus.h"
 
class DaliClass {
  public:
    enum daliCmd {
      CMD_OFF = 0, CMD_UP = 1, CMD_DOWN = 2, CMD_STEP_UP = 3, CMD_STEP_DOWN = 4,
      CMD_RECALL_MAX = 5, CMD_RECALL_MIN = 6, CMD_STEP_DOWN_AND_OFF = 7, CMD_ON_AND_STEP_UP = 8,
      CMD_GO_TO_LAST = 10, // DALI-2
      CMD_GO_TO_SCENE = 16,
      CMD_RESET = 32, CMD_ARC_TO_DTR = 33,
      CMD_SAVE_VARS = 34, CMD_SET_OPMODE = 35, CMD_RESET_MEM = 36, CMD_IDENTIFY = 37, // DALI-2
      CMD_DTR_AS_MAX = 42, CMD_DTR_AS_MIN = 43, CMD_DTR_AS_FAIL = 44, CMD_DTR_AS_POWER_ON = 45, CMD_DTR_AS_FADE_TIME = 46, CMD_DTR_AS_FADE_RATE = 47,
      CMD_DTR_AS_EXT_FADE_TIME = 48, // DALI-2
      CMD_DTR_AS_SCENE = 64, CMD_REMOVE_FROM_SCENE = 80,
      CMD_ADD_TO_GROUP = 96, CMD_REMOVE_FROM_GROUP = 112,
      CMD_DTR_AS_SHORT = 128,
      CMD_QUERY_STATUS = 144, CMD_QUERY_BALLAST = 145, CMD_QUERY_LAMP_FAILURE = 146, CMD_QUERY_LAMP_POWER_ON = 147, CMD_QUERY_LIMIT_ERROR = 148,
      CMD_QUERY_RESET_STATE = 149, CMD_QUERY_MISSING_SHORT = 150, CMD_QUERY_VERSION = 151, CMD_QUERY_DTR = 152, CMD_QUERY_DEVICE_TYPE = 153,
      CMD_QUERY_PHYS_MIN = 154, CMD_QUERY_POWER_FAILURE = 155,
      CMD_QUERY_OPMODE = 158, CMD_QUERY_LIGHTTYPE = 159, // DALI-2
      CMD_QUERY_ACTUAL_LEVEL = 160, CMD_QUERY_MAX_LEVEL = 161, CMD_QUERY_MIN_LEVEL = 162, CMD_QUERY_POWER_ON_LEVEL = 163, CMD_QUERY_FAIL_LEVEL = 164, CMD_QUERY_FADE_SPEEDS = 165,
      CMD_QUERY_SPECMODE = 166, CMD_QUERY_NEXT_DEVTYPE = 167, CMD_QUERY_EXT_FADE_TIME = 168, CMD_QUERY_CTRL_GEAR_FAIL = 169, // DALI-2
      CMD_QUERY_SCENE_LEVEL = 176,
      CMD_QUERY_GROUPS_0_7 = 192, CMD_QUERY_GROUPS_8_15 = 193,
      CMD_QUERY_ADDRH = 194, CMD_QUERY_ADDRM = 195, CMD_QUERY_ADDRL = 196
    };
    
    enum daliSpecialCmd {
      CMD_TERMINATE = 256, CMD_SET_DTR = 257,
      CMD_INITIALISE = 258, CMD_RANDOMISE = 259, CMD_COMPARE = 260, CMD_WITHDRAW = 261,
      CMD_SEARCHADDRH = 264, CMD_SEARCHADDRM = 265, CMD_SEARCHADDRL = 266,
      CMD_PROGRAMSHORT = 267, CMD_VERIFYSHORT = 268, CMD_QUERY_SHORT = 269, CMD_PHYS_SEL = 270,
      CMD_ENABLE_DT = 272, CMD_LOAD_DTR1 = 273, CMD_LOAD_DTR2 = 274, CMD_WRITE_MEM_LOC = 275,
      CMD_WRITE_MEM_LOC_NOREPLY = 276 // DALI-2
    };
 
    enum daliDevTypes {
      FLUORESCENT_LAMP,
      EMERGENCY_LIGHT,
      DISCHARGE_LAMP,
      HALOGEN_LAMP,
      INCANDESCENT_LAMP,
      DC_CONVERTER,
      LED_MODULE,
      SWITCH,
      COLOUR_CTRL,
      SEQUENCER,
      OPTICAL_CTRL
    };
 
    enum daliAddressTypes {
      DALI_SHORT_ADDRESS = 0,
      DALI_GROUP_ADDRESS = 1
    };
 
    void begin(byte tx_pin, byte rx_pin, bool active_low = true);
 
    daliReturnValue sendArc(byte address, byte value, byte addr_type = DALI_SHORT_ADDRESS);
 
    daliReturnValue sendArcWait(byte address, byte value, byte addr_type = DALI_SHORT_ADDRESS, byte timeout = 50);
 
    daliReturnValue sendCmd(byte address, byte command, byte addr_type = DALI_SHORT_ADDRESS);
    
    int sendCmdWait(byte address, byte command, byte addr_type = DALI_SHORT_ADDRESS, byte timeout = 50);
    
    daliReturnValue sendSpecialCmd(word command, byte value = 0);
 
    int sendSpecialCmdWait(word command, byte value = 0, byte timeout = 50);
 
    int sendRawWait(const byte * message, byte length, byte timeout = 50);
 
    void commission(byte startAddress = 0, bool onlyNew = false);
    
    void commission_tick();
    
    byte nextShortAddress;
    
    bool commissionOnlyNew;
 
    enum commissionStateEnum { 
      COMMISSION_OFF, COMMISSION_INIT, COMMISSION_INIT2, COMMISSION_WRITE_DTR, COMMISSION_REMOVE_SHORT, COMMISSION_REMOVE_SHORT2, COMMISSION_RANDOM, COMMISSION_RANDOM2, COMMISSION_RANDOMWAIT,
      COMMISSION_STARTSEARCH, COMMISSION_SEARCHHIGH, COMMISSION_SEARCHMID, COMMISSION_SEARCHLOW,
      COMMISSION_COMPARE, COMMISSION_CHECKFOUND, COMMISSION_PROGRAMSHORT,
      COMMISSION_VERIFYSHORT, COMMISSION_VERIFYSHORTRESPONSE, COMMISSION_QUERYDEVICETYPE, COMMISSION_QUERYDEVICETYPERESPONSE,
      COMMISSION_WITHDRAW, COMMISSION_TERMINATE
    };
    commissionStateEnum commissionState = COMMISSION_OFF; 
  protected:
    byte * prepareCmd(byte * message, byte address, byte command, byte type, byte selector);
    
    byte * prepareSpecialCmd(byte * message, word command, byte value);
};
 
extern DaliClass Dali;
 
#endif // DALI_H