AS.h

//- -----------------------------------------------------------------------------------------------------------------------
// AskSin driver implementation
// 2013-08-03 <trilu@gmx.de> Creative Commons - http://creativecommons.org/licenses/by-nc-sa/3.0/de/
//- -----------------------------------------------------------------------------------------------------------------------
//- AskSin protocol functions ---------------------------------------------------------------------------------------------
//- with a lot of support from martin876 at FHEM forum
//- -----------------------------------------------------------------------------------------------------------------------

#ifndef _NAS_H
#define _NAS_H

#include "HAL.h"
#include "CC1101.h"
#include "EEprom.h"
#include "Send.h"
#include "Receive.h"
#include "Registrar.h"
#include "ConfButton.h"
#include "StatusLed.h"
#include "Power.h"
#include "Battery.h"
#include "Version.h"

class AS {
    friend class SN;
    friend class RV;
    friend class RG;
    friend class PW;

  public:       //---------------------------------------------------------------------------------------------------------
    EE ee;          
    SN sn;          
    RG rg;          
    CB confButton;      
    LD ld;          
    PW pw;          
    CC cc;          
    BT bt;

  protected:    //---------------------------------------------------------------------------------------------------------
  private:      //---------------------------------------------------------------------------------------------------------

    //CC cc;        ///< load communication module
    RV rv;          

    struct s_confFlag {                 // - remember that we are in config mode, for config start message receive
        uint8_t  active   :1;   //< indicates status, 1 if config mode is active
        uint8_t  cnl;       //< channel
        uint8_t  lst;       //< list
        uint8_t  idx;       //< peer index
    } cFlag;

    struct s_stcSlice {                     // - send peers or reg in slices, store for send slice function
        uint8_t active   :1;                // indicates status of poll routine, 1 is active
        uint8_t peer     :1;                // is it a peer list message
        uint8_t reg2     :1;                // or a register send
        uint8_t reg3     :1;                // not implemented at the moment
        uint8_t totSlc;                     // amount of necessary slices to send content
        uint8_t curSlc;                     // counter for slices which are already send
        uint8_t cnl;                        // indicates channel
        uint8_t lst;                        // the respective list
        uint8_t idx;                        // the peer index
        uint8_t mCnt;                       // the message counter
        uint8_t toID[3];                    // to whom to send
    } stcSlice;

    struct s_stcPeer {
        uint8_t active   :1;                // indicates status of poll routine, 1 is active
        uint8_t rnd      :3;                // send retries
        uint8_t burst    :1;                // burst flag for send function
        uint8_t bidi     :1;                // ack required
        uint8_t mTyp;                       // message type to build the right message
        uint8_t *pL;                        // pointer to payload
        uint8_t lenPL;                      // length of payload
        uint8_t cnl;                        // which channel is the sender
        uint8_t curIdx;                     // current peer slots
        uint8_t maxIdx;                     // amount of peer slots
        uint8_t slt[8];                     // slot measure, all filled in a first step, if ACK was received, one is taken away by slot
    } stcPeer;

    struct s_l4_0x01 {
        uint8_t  peerNeedsBurst      :1;     // 0x01, s:0, e:1
        uint8_t                      :6;     //
        uint8_t  expectAES           :1;     // 0x01, s:7, e:8
    } l4_0x01;

    uint8_t pairActive    :1;

  public:       //---------------------------------------------------------------------------------------------------------
    AS();

    void init(void);

    void poll(void);

    // - send functions --------------------------------
    void sendDEVICE_INFO(void);
    void sendACK(void);
    void sendACK_STATUS(uint8_t cnl, uint8_t stat, uint8_t dul);
    void sendNACK(void);
    void sendNACK_TARGET_INVALID(void);
    void sendINFO_ACTUATOR_STATUS(uint8_t cnl, uint8_t stat, uint8_t cng);
    void sendINFO_TEMP(void);
    void sendHAVE_DATA(void);
    void sendSWITCH(void);
    void sendTimeStamp(void);
    void sendREMOTE(uint8_t cnl, uint8_t burst, uint8_t *pL);
    void sendSensor_event(uint8_t cnl, uint8_t burst, uint8_t *pL);
    void sendSensorData(void);
    void sendClimateEvent(void);
    void sendSetTeamTemp(void);
    void sendWeatherEvent(void);
    void send_generic_event(uint8_t cnl, uint8_t burst, uint8_t mTyp, uint8_t len, uint8_t *pL);
    
  private:      //---------------------------------------------------------------------------------------------------------

    // - poll functions --------------------------------
    void sendSliceList(void);                                                               // scheduler to send config messages, peers and regs
    void sendPeerMsg(void);                                                                 // scheduler for peer messages
    void prepPeerMsg(uint8_t *xPeer, uint8_t retr);
            
    // - receive functions -----------------------------
    void recvMessage(void);

    // - send functions --------------------------------
    void sendINFO_SERIAL(void);
    void sendINFO_PEER_LIST(uint8_t len);
    void sendINFO_PARAM_RESPONSE_PAIRS(uint8_t len);
    void sendINFO_PARAM_RESPONSE_SEQ(uint8_t len);
    void sendINFO_PARAMETER_CHANGE(void);

    
  protected:    //---------------------------------------------------------------------------------------------------------
    // - homematic specific functions ------------------
    void decode(uint8_t *buf);                                                              // decodes the message
    void encode(uint8_t *buf);                                                              // encodes the message
    void explainMessage(uint8_t *buf);                                                      // explains message content, part of debug functions

    // - some helpers ----------------------------------


};
extern AS hm;

class waitTimer {

  private:      //---------------------------------------------------------------------------------------------------------
    uint8_t  armed;
    uint32_t checkTime;
    uint32_t startTime;

  public:       //---------------------------------------------------------------------------------------------------------
    uint8_t  done(void);
    void     set(uint32_t ms);
    uint32_t remain(void);
};



uint32_t byteTimeCvt(uint8_t tTime);
uint32_t intTimeCvt(uint16_t iTime);

#endif