on_off.h

Go to the documentation of this file.

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

#ifndef HF_ITF_ON_OFF_H
#define HF_ITF_ON_OFF_H

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

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

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

      namespace OnOff
      {
         typedef enum _CMD
         {
            ON_CMD       = 0x01, 
            OFF_CMD      = 0x02, 
            TOGGLE_CMD   = 0x03, 
            __LAST_CMD__ = TOGGLE_CMD,
         } CMD;

         typedef enum _Attributes
         {
            STATE_ATTR    = 0x01, 
            __LAST_ATTR__ = STATE_ATTR,
         } Attributes;

         struct State: public HF::Attributes::Attribute<bool>
         {
            static constexpr uint8_t ID        = STATE_ATTR;  
            static constexpr bool    WRITABBLE = false;       

            State(bool state = false, HF::Interface *owner = nullptr):
               Attribute<bool>(HF::Interface::ON_OFF, ID, owner, state, WRITABBLE)
            {}
         };

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

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

            Base() {}
         };

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

            bool _state;

            public:

            Server(): _state(false) {}

            virtual ~Server() {}

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

            virtual void on(Protocol::Address &source);

            virtual void off(Protocol::Address &source);

            virtual void toggle(Protocol::Address &source);


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

            void state(bool state);

            bool state();

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

            HF::Attributes::IAttribute *attribute(uint8_t uid)
            {
               return Interfaces::create_attribute(this, uid);
            }

            HF::Attributes::UIDS attributes(uint8_t pack_id =
                                               HF::Attributes::Pack::MANDATORY) const
            {
               UNUSED(pack_id);
               /* *INDENT-OFF* */
               return HF::Attributes::UIDS ({ OnOff::STATE_ATTR });
               /* *INDENT-ON* */
            }

            protected:

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

         struct Client: public InterfaceRole<OnOff::Base, HF::Interface::CLIENT_ROLE>
         {
            // ======================================================================
            // Commands
            // ======================================================================

            void on(Protocol::Address &addr);

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

            void off(Protocol::Address &addr);

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

            void toggle(Protocol::Address &addr);

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

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

      }  // namespace OnOff

   }  // namespace Interfaces

}   // namespace HF

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

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

std::ostream &operator<<(std::ostream &stream, const HF::Interfaces::OnOff::Attributes attribute);

#endif /* HF_ITF_ON_OFF_H */