simple_button.h

Go to the documentation of this file.

// =============================================================================
// =============================================================================

#ifndef HF_ITF_SIMPLE_BUTTON_H
#define HF_ITF_SIMPLE_BUTTON_H

#include "hanfun/protocol.h"
#include "hanfun/interface.h"

// =============================================================================
// API
// =============================================================================

namespace HF
{
   namespace Interfaces
   {
      // Forward declaration.
      namespace SimpleButton
      {
         class Server;
      }

      HF::Attributes::IAttribute *create_attribute(SimpleButton::Server *server, uint8_t uid);

      namespace SimpleButton
      {
         typedef enum _CMD
         {
            SHORT_PRESS_CMD        = 1, 
            LONG_PRESS_CMD         = 2, 
            EXTRA_LONG_PRESS_CMD   = 3, 
            DOUBLE_CLICK_PRESS_CMD = 4, 
            __LAST_CMD__           = DOUBLE_CLICK_PRESS_CMD
         } CMD;

         typedef enum _Attributes
         {
            SHORT_PRESS_MAX_DURATION_ATTR      = 1, 
            EXTRA_LONG_PRESS_MIN_DURATION_ATTR = 2, 
            DOUBLE_CLICK_GAP_DURATION_ATTR     = 3, 
            __LAST_ATTR__                      = DOUBLE_CLICK_GAP_DURATION_ATTR
         } Attributes;

         // =============================================================================
         // Attribute Helper classes
         // =============================================================================

         struct ShortPressMaxDuration: public HF::Attributes::Attribute<uint16_t>
         {
            static constexpr uint8_t ID       = SHORT_PRESS_MAX_DURATION_ATTR; 
            static constexpr bool    WRITABLE = true;                          

            ShortPressMaxDuration(uint16_t value = 0, HF::Interface *owner = nullptr):
               Attribute<uint16_t>(HF::Interface::SIMPLE_BUTTON, ID, owner, value, WRITABLE)
            {}
         };

         struct ExtraLongPressMinDuration: public HF::Attributes::Attribute<uint16_t>
         {
            static constexpr uint8_t ID       = EXTRA_LONG_PRESS_MIN_DURATION_ATTR; 
            static constexpr bool    WRITABLE = true;                               

            ExtraLongPressMinDuration(uint16_t value = 0, HF::Interface *owner = nullptr):
               Attribute<uint16_t>(HF::Interface::SIMPLE_BUTTON, ID, owner, value, WRITABLE)
            {}
         };

         struct DoubleClickGapDuration: public HF::Attributes::Attribute<uint16_t>
         {
            static constexpr uint8_t ID       = DOUBLE_CLICK_GAP_DURATION_ATTR; 
            static constexpr bool    WRITABLE = true;                           

            DoubleClickGapDuration(uint16_t value = 0, HF::Interface *owner = nullptr):
               Attribute<uint16_t>(HF::Interface::SIMPLE_BUTTON, ID, owner, value, WRITABLE)
            {}
         };

         HF::Attributes::IAttribute *create_attribute(uint8_t uid);

         struct Base: public Interface<HF::Interface::SIMPLE_BUTTON>
         {
            protected:

            Base(): Interface<HF::Interface::SIMPLE_BUTTON>() {}
         };

         class Server: public InterfaceRole<SimpleButton::Base, HF::Interface::SERVER_ROLE>
         {
            protected:

            uint16_t _short_press_max_duration;      
            uint16_t _extra_long_press_min_duration; 

#ifdef HF_ITF_SIMPLE_BUTTON_DOUBLE_CLICK_PRESS_CMD
            uint16_t _double_click_gap_duration;
#endif

            uint16_t _timestamp;         

#ifdef HF_ITF_SIMPLE_BUTTON_DOUBLE_CLICK_PRESS_CMD
            bool _short_click_cmd;   
#endif

            public:

            static constexpr uint16_t DOUBLE_CLICK_GAP_DURATION_MIN_VALUE = 0x0064;

            Server(): InterfaceRole<SimpleButton::Base, HF::Interface::SERVER_ROLE>(),
               _short_press_max_duration(0), _extra_long_press_min_duration(0),
#ifdef HF_ITF_SIMPLE_BUTTON_DOUBLE_CLICK_PRESS_CMD
               _double_click_gap_duration(DOUBLE_CLICK_GAP_DURATION_MIN_VALUE),
#endif
               _timestamp(0),
#ifdef HF_ITF_SIMPLE_BUTTON_DOUBLE_CLICK_PRESS_CMD
               _short_click_cmd(false)
#endif
            {}

            virtual ~Server() {}

            // =============================================================================
            // API
            // =============================================================================

            void pressed(const Protocol::Address &addr, uint16_t timestamp);

            void pressed(uint16_t timestamp)
            {
               Protocol::Address addr;
               pressed(addr, timestamp);
            }

            void released(const Protocol::Address &addr, uint16_t timestamp);

            void released(uint16_t timestamp)
            {
               Protocol::Address addr;
               released(addr, timestamp);
            }

            protected:

            // ======================================================================
            // Commands
            // ======================================================================

            void short_press(const Protocol::Address &addr);

            void short_press()
            {
               Protocol::Address addr;
               short_press(addr);
            }

            void long_press(const Protocol::Address &addr);

            void long_press()
            {
               Protocol::Address addr;
               long_press(addr);
            }

#ifdef HF_ITF_SIMPLE_BUTTON_EXTRA_LONG_PRESS_CMD

            void extra_long_press(const Protocol::Address &addr);

            void extra_long_press()
            {
               Protocol::Address addr;
               extra_long_press(addr);
            }
#endif

#ifdef HF_ITF_SIMPLE_BUTTON_DOUBLE_CLICK_PRESS_CMD

            void double_click_press(const Protocol::Address &addr);

            void double_click_press()
            {
               Protocol::Address addr;
               double_click_press(addr);
            }
#endif

            // ======================================================================

            public:

            // =============================================================================
            // Get/Set API.
            // =============================================================================

            uint16_t short_press_max_duration() const;

            virtual void short_press_max_duration(uint16_t __value);

            uint16_t extra_long_press_min_duration() const;

            virtual void extra_long_press_min_duration(uint16_t __value);

#ifdef HF_ITF_SIMPLE_BUTTON_DOUBLE_CLICK_PRESS_CMD

            uint16_t double_click_gap_duration() const;

            virtual void double_click_gap_duration(uint16_t __value);
#endif

            // =============================================================================
            // Attribute API.
            // =============================================================================

            HF::Attributes::IAttribute *attribute(uint8_t uid);

            HF::Attributes::UIDS attributes(uint8_t pack_id =
                                               HF::Attributes::Pack::MANDATORY) const;

         };

         struct Client: public InterfaceRole<SimpleButton::Base, HF::Interface::CLIENT_ROLE>
         {
            Client(): InterfaceRole<SimpleButton::Base, HF::Interface::CLIENT_ROLE>() {}

            virtual ~Client() {}

            // ======================================================================
            // Commands
            // ======================================================================

            // ======================================================================

            // ======================================================================
            // Events
            // ======================================================================

#ifdef HF_ITF_SIMPLE_BUTTON_SHORT_PRESS_CMD

            virtual void short_press(const Protocol::Address &addr);
#endif

#ifdef HF_ITF_SIMPLE_BUTTON_LONG_PRESS_CMD

            virtual void long_press(const Protocol::Address &addr);
#endif

#ifdef HF_ITF_SIMPLE_BUTTON_EXTRA_LONG_PRESS_CMD

            virtual void extra_long_press(const Protocol::Address &addr);
#endif

#ifdef HF_ITF_SIMPLE_BUTTON_DOUBLE_CLICK_PRESS_CMD

            virtual void double_click_press(const Protocol::Address &addr);
#endif

            // =============================================================================
            protected:

            Common::Result handle_command(Protocol::Packet &packet, Common::ByteArray &payload,
                                          uint16_t offset);
         };

      }  // namespace SimpleButton

   }  // namespace Interfaces

}   // namespace HF

// =============================================================================
// Stream Helpers
// =============================================================================

std::ostream &operator<<(std::ostream &stream, const HF::Interfaces::SimpleButton::CMD command);

std::ostream &operator<<(std::ostream &stream,
                         const HF::Interfaces::SimpleButton::Attributes attribute);
#endif /* HF_ITF_SIMPLE_BUTTON_H */