HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
simple_button.h File Reference

This file contains the definitions for the Simple Button interface. More...

#include "hanfun/protocol.h"
#include "hanfun/interface.h"
+ Include dependency graph for simple_button.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  HF::Interfaces::SimpleButton::ShortPressMaxDuration
 Helper class to handle the Short Press Max Duration attribute for the Simple Button interface. More...
 
struct  HF::Interfaces::SimpleButton::ExtraLongPressMinDuration
 Helper class to handle the Extra Long Press Min Duration attribute for the Simple Button interface. More...
 
struct  HF::Interfaces::SimpleButton::DoubleClickGapDuration
 Helper class to handle the Double Click Gap Duration attribute for the Simple Button interface. More...
 
struct  HF::Interfaces::SimpleButton::Base
 Simple Button Interface : Parent. More...
 
class  HF::Interfaces::SimpleButton::Server
 Simple Button Interface : Server side implementation. More...
 
struct  HF::Interfaces::SimpleButton::Client
 Simple Button Interface : Client side implementation. More...
 

Namespaces

 HF
 Top-level namespace for the HAN-FUN library.
 
 HF::Interfaces
 This is the top-level namespace for the implemented Interfaces.
 
 HF::Interfaces::SimpleButton
 This namespace contains the implementation of the Simple Button interface.
 

Enumerations

enum  HF::Interfaces::SimpleButton::CMD { HF::Interfaces::SimpleButton::SHORT_PRESS_CMD = 1, HF::Interfaces::SimpleButton::LONG_PRESS_CMD = 2, HF::Interfaces::SimpleButton::EXTRA_LONG_PRESS_CMD = 3, HF::Interfaces::SimpleButton::DOUBLE_CLICK_PRESS_CMD = 4 }
 Command IDs. More...
 
enum  HF::Interfaces::SimpleButton::Attributes { HF::Interfaces::SimpleButton::SHORT_PRESS_MAX_DURATION_ATTR = 1, HF::Interfaces::SimpleButton::EXTRA_LONG_PRESS_MIN_DURATION_ATTR = 2, HF::Interfaces::SimpleButton::DOUBLE_CLICK_GAP_DURATION_ATTR = 3 }
 Attributes. More...
 

Functions

HF::Attributes::IAttributeHF::Interfaces::create_attribute (SimpleButton::Server *server, uint8_t uid)
 Create an attribute object that can hold the attribute with the given uid. More...
 
HF::Attributes::IAttributeHF::Interfaces::SimpleButton::create_attribute (uint8_t uid)
 Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleButton::Server *,uint8_t) More...
 
std::ostream & operator<< (std::ostream &stream, const HF::Interfaces::SimpleButton::CMD command)
 Convert the given command into a string and write it to the given stream. More...
 
std::ostream & operator<< (std::ostream &stream, const HF::Interfaces::SimpleButton::Attributes attribute)
 Convert the given attribute into a string and write it to the given stream. More...
 

Detailed Description

This file contains the definitions for the Simple Button interface.

Version
1.5.3

For licensing information, please see the file 'LICENSE' in the root folder.

Initial development by Bithium S.A. [http://www.bithium.com]

Definition in file simple_button.h.