simple_keypad.h

Go to the documentation of this file.

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

#ifndef HF_ITF_SIMPLE_KEYPAD_H
#define HF_ITF_SIMPLE_KEYPAD_H

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

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

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

      namespace SimpleKeypad
      {
         typedef enum _CMD
         {
            KEYPRESSED_CMD = 0x01,  
            __LAST_CMD__   = KEYPRESSED_CMD
         } CMD;

         struct KeyPressed
         {
            uint32_t key_id;

            KeyPressed(uint32_t _key_id = 0): key_id(_key_id)
            {}

            static constexpr uint16_t min_size = sizeof(uint32_t);

            uint16_t size() const
            {
               return min_size;
            }

            uint16_t pack(Common::ByteArray &array, uint16_t offset = 0) const;

            uint16_t unpack(const Common::ByteArray &array, uint16_t offset = 0);
         };

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

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

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

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

            Server(): InterfaceRole<SimpleKeypad::Base, HF::Interface::SERVER_ROLE>() {}

            virtual ~Server() {}

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

            virtual void key_pressed(const Protocol::Address &addr, KeyPressed &msg);

            virtual void key_received(const uint32_t key_id)
            {
               UNUSED(key_id);
            }

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

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

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

            virtual ~Client() {}

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

            void key_pressed(const Protocol::Address &addr, uint32_t key_id);

            // ======================================================================
         };

      }  // namespace SimpleKeypad

   }  // namespace Interfaces

}   // namespace HF

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

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

#endif /* HF_ITF_SIMPLE_KEYPAD_H */