Examples

This module contains the classes for the provided example applications. More...

Namespaces
	HF::Application
	This namespace contains the declaration of the functions that implement the HAN-FUN example applications.

Data Structures
struct	Base
	This class represents a HAN-FUN Concentrator. More...
struct	ICommand
	Example application menu entry API. More...
class	Command
	Parent class for the commands API implementations. More...
struct	Node
	This class represents a node in the HAN-FUN network. More...
struct	SimpleLight
	Unit implementing a Simple Light. More...
struct	SimpleSwitch
	Unit implementing a Simple Switch. More...
struct	msg_t
	Message sent between the concentrator and the nodes. More...
struct	hello_msg_t
	Hello message payload. More...

Macros
#define	HF_APP_CONFIG_FILE   "./hanfun.json"
	JSON database file. More...
#define	COMMAND(_name, _key, _help)
	Helper macro to define new commands.
#define	COMMAND_ADD(_name)
	Helper macro to add a new command to the registry.
#define	STRTOL(X)   strtol(X.c_str(), NULL, 10);
	Helper macro to convert a std::string into a number (base 10).
#define	STRTOL_HEX(X)   strtol(X.c_str(), NULL, 16);
	Helper macro to convert a std::string into a number (base 16).
#define	NONE_MSG   0xFFFF
	No message primitive id. More...
#define	HELLO_MSG   0x0101
	Hello message primitive id. More...
#define	DATA_MSG   0x0201
	Data message primitive id. More...
#define	CHECK_STATUS()
	Helper macro the check libuv command status.

Typedefs
typedef HF::Devices::Concentrator::Unit0< HF::Core::DeviceInformation::Server, ::DeviceManagement::Server, HF::Core::AttributeReporting::Server, ::BindManagement::Server >	Unit0
	Custom Unit0 declaration.

Functions
void	to_json (const HF::Common::Interface &interface, Json::Value &node)
	Serialize a HF::Common::Interface to the given Json::Value. More...
void	to_json (const HF::Core::DeviceManagement::Unit &unit, Json::Value &node)
	Serialize a HF::Core::DeviceManagement::Unit to the given Json::Value. More...
void	to_json (const HF::Core::DeviceManagement::Device &device, Json::Value &node)
	Serialize a HF::Core::DeviceManagement::Device to the given Json::Value. More...
void	to_json (const HF::Protocol::Address &address, Json::Value &node)
	Serialize a HF::Protocol::Address to the given Json::Value. More...
void	to_json (const HF::Core::BindManagement::Entry &entry, Json::Value &node)
	Serialize a HF::Core::BindManagement::Entry to the given Json::Value. More...
void	from_json (Json::Value &node, HF::Common::Interface &interface)
	Fill a HF::Common::Interface from the given Json::Value object. More...
void	from_json (Json::Value &node, HF::Core::DeviceManagement::Unit &unit)
	Fill a HF::Core::DeviceManagement::Unit from the given Json::Value object. More...
void	from_json (Json::Value &node, HF::Core::DeviceManagement::Device &device)
	Fill a HF::Core::DeviceManagement::Device from the given Json::Value object. More...
void	from_json (Json::Value &node, HF::Protocol::Address &address)
	Fill a HF::Protocol::Address from the given Json::Value object. More...
void	from_json (Json::Value &node, HF::Core::BindManagement::Entry &entry)
	Fill a HF::Core::BindManagement::Entry from the given Json::Value object. More...
void	to_json (HF::UID::UID *uid, Json::Value &node)
	Serialize a HF::UID::UID pointer to the given Json::Value. More...
void	from_json (Json::Value &node, HF::UID::UID *&uid)
	Create a new HF::UID::UID based on the fields present in the given Json::Value object. More...
	COMMAND (ListRegs, "lr", "lr:list registrations.")
	ListRegs List registrations command.
	COMMAND (ListBinds, "lb", "lb:list binds.")
	List binds command.
	COMMAND (Register, "r", "r 1 x:register device x.\ 0:exit registration mode.")
	Setup registration command. More...
	COMMAND (Deregister, "d", "d x:de-register device x.")
	De-register device command.
	COMMAND (Unbind, "u", "u x y:unbind device x with y.")
	Destroy bind command.
	COMMAND (GlobalBind, "gb", "gb 1:create bind to receive all interface events.\ "gb 0:remove bind to receive all interface events.")
	Global binds command.
	COMMAND (On, "on", "on d u:Send an ON command to device/unit pair.")
	Send ON command.
	COMMAND (Off, "off", "off d u:Send an OFF command to device/unit pair.")
	Send OFF command.
	COMMAND (Toggle, "toggle", "toggle d u:Send a TOGGLE command to device/unit pair.")
	Send TOGGLE command.
	COMMAND (DevInfo, "di", "di m d:Get device information mandatory attributes.\ "di a d:Get device information all attributes.")
	Get Device information.
uv_buf_t	alloc_buffer (uv_handle_t *handle, size_t suggested_size)
	This function is used to allocate the buffers used with libuv. More...
	COMMAND (Register, "r", "r:register device")
	Register node command.
	COMMAND (Address, "a", "a:device address")
	Print node address command.
	COMMAND (SimpleLight, "sl", "sl:set device as a simple light")
	Change device to a simple light.
	COMMAND (SimpleSwitch, "ss", "ss:set device as a simple switch")
	Change device to a simple switch.
	COMMAND (On, "on", "on:On Command")
	Send an on command from the simple switch.
	COMMAND (Off, "off", "off:Off Command")
	Send an off command from the simple switch.
	COMMAND (Toggle, "toggle", "toggle:Toggle Command")
	Send a toggle command from the simple switch.
void	print_error (uv_err_t status)
	Print a user friendly string for given status code. More...
void	DeviceManagement::Entries::insert (const Device &device)
	Insert a device management entry into the database. More...
bool	DeviceManagement::Server::available (uint16_t address)
	Check if the given address is available for registration. More...
uint16_t	DeviceManagement::Server::next_address ()
	Return next available address for registering a device. More...
bool	DeviceManagement::Server::deregister (uint16_t address)
	De-register the device with the given address. More...
void	DeviceManagement::Server::save (Json::Value &root)
	Save the device entries into the JSON database. More...
void	DeviceManagement::Server::restore (Json::Value root)
	Restore the device entries from the JSON database. More...
void	BindManagement::Entries::insert (Entry &entry)
	Insert a bind management entry into the database. More...
void	BindManagement::Server::save (Json::Value &root)
	Save the bind entries into the JSON database. More...
void	BindManagement::Server::restore (Json::Value root)
	Restore the bind entries from the JSON database. More...
void	Base::receive (HF::Protocol::Packet &packet, HF::Common::ByteArray &payload, uint16_t offset)
	Callback to deliver a packet received from the transport layer. More...
bool	Base::has_bind (uint16_t dev_addr_1, uint16_t dev_addr_2)
	Check if bind exists. More...
uint8_t	Base::bind (uint16_t dev_addr_1, uint16_t dev_addr_2)
	Create a new bind entry. More...
bool	Base::unbind (uint16_t dev_addr_1, uint16_t dev_addr_2)
	Remove the binding entry for the given devices. More...
void	HF::Application::Initialize (HF::Transport::Layer &transport)
	Initialize the application. More...
void	HF::Application::Save ()
	Save application configuration.
void	HF::Application::Restore ()
	Restore application configuration.
void	HF::Application::Saved ()
	Callback indicating that the application configuration has been saved.
void	HF::Application::Restored ()
	Callback indicating that the application configuration has been restored.
void	Node::receive (HF::Protocol::Packet &packet, HF::Common::ByteArray &payload, uint16_t offset)
	Callback to deliver a packet received from the transport layer. More...
void	SimpleLight::on (HF::Protocol::Address &source)
	Callback that is called when a ON_CMD message is received. More...
void	SimpleLight::off (HF::Protocol::Address &source)
	Callback that is called when a OFF_CMD message is received. More...
void	SimpleLight::toggle (HF::Protocol::Address &source)
	Callback that is called when a TOGGLE_CMD message is received. More...
void	HF::Application::Transport::initialize ()
	Initialize the associated transport layer. More...
void	HF::Application::Transport::destroy ()
	Free the system resources associated with this transport layer.
void	HF::Application::Link::send (HF::Common::ByteArray &array)
	Send the data in the given ByteArray using the link to the remote end-point. More...

Variables
uint16_t	arg2 = STRTOL(args[1])
	Create bind command.

Detailed Description

This module contains the classes for the provided example applications.

Macro Definition Documentation

DATA_MSG

#define DATA_MSG   0x0201

Data message primitive id.

Definition at line 45 of file transport.cpp.

HELLO_MSG

#define HELLO_MSG   0x0101

Hello message primitive id.

Definition at line 44 of file transport.cpp.

HF_APP_CONFIG_FILE

#define HF_APP_CONFIG_FILE   "./hanfun.json"

JSON database file.

Definition at line 47 of file base_app.cpp.

Referenced by HF::Application::Restore(), and HF::Application::Save().

NONE_MSG

#define NONE_MSG   0xFFFF

No message primitive id.

Definition at line 43 of file transport.cpp.

Function Documentation

alloc_buffer()

uv_buf_t alloc_buffer	(	uv_handle_t *	handle,
		size_t	suggested_size
	)

This function is used to allocate the buffers used with libuv.

Parameters

[in]	handle	a pointer to the handle to allocate the buffer for.
[in]	suggested_size	number bytes to allocate.

Returns

buffer allocated.

Definition at line 212 of file transport.cpp.

References UNUSED.

{
   UNUSED(handle);
   return uv_buf_init((char *) calloc(1, suggested_size), suggested_size);
}

available()

bool DeviceManagement::Server::available

(

uint16_t

address

)

Check if the given address is available for registration.

Parameters

[in]

address

device address to check.

Return values

<tt>true</tt>	if no device is registered with the given address;
<tt>false</tt>	otherwise.

Definition at line 90 of file base.cpp.

References HF::Core::DeviceManagement::Device::address, and HF::Protocol::BROADCAST_ADDR.

{
   if (address == 0 || address == HF::Protocol::BROADCAST_ADDR)
   {
      return false;
   }

   /* *INDENT-OFF* */
   auto it = std::find_if(entries().begin(), entries().end(),
                          [address](const HF::Core::DeviceManagement::Device &dev)
                          {
                             return address == dev.address;
                          });
   /* *INDENT-ON* */

   return it == entries().end();
}

bind()

uint8_t Base::bind	(	uint16_t	dev_addr_1,
		uint16_t	dev_addr_2
	)

Create a new bind entry.

Parameters

[in]	dev_addr_1	HAN-FUN address of the first device.
[in]	dev_addr_2	HAN-FUN address of the second device.

Return values

0	Bind created.
1	Bind already created.
2	First device does not exist.
3	Second device does not exist.

Definition at line 629 of file base.cpp.

References HF::Common::OK, HF::Interface::ON_OFF, and HF::Interface::SERVER_ROLE.

{
   if (this->has_bind(dev_addr_1, dev_addr_2))
   {
      return 1;
   }

   HF::Protocol::Address source(dev_addr_1, 1);
   HF::Common::Interface itf(HF::Interface::ON_OFF, HF::Interface::SERVER_ROLE);
   HF::Protocol::Address destination(dev_addr_2, 1);

   auto res = _unit0.bind_management()->add(source, destination, itf);

   if (res == HF::Common::OK)
   {
      return 0;
   }

   if (_unit0.device_management()->entry(dev_addr_1) == nullptr)
   {
      return 2;
   }

   if (_unit0.device_management()->entry(dev_addr_2) == nullptr)
   {
      return 3;
   }

   return 4;
}

COMMAND()

COMMAND	(	Register	,
		"r"	,
		"r 1 x:register device x.\ 0:exit registration mode."
	)

Setup registration command.

< Disable Registration

< Enable Registration

Definition at line 116 of file base_app.cpp.

References LOG.

                             :register device x.\nr 0:exit registration mode.")
{
   if (args.size() > 0 && args[0] == "0")  //!< Disable Registration
   {
#ifdef HF_APP_EXT_REG

      if (HF::Application::Registration(false))
      {
         LOG(INFO) << "Disable Registration mode: SUCCESS" << NL;
      }
      else
      {
         LOG(WARN) << "Disable Registration mode: FAIL" << NL;
      }

#endif
   }
   else if (args.size() > 1 && args[0] == "1")  //!< Enable Registration
   {
      uint16_t address = STRTOL(args[1]);

      if (base.unit0()->device_management()->available(address) && address != 0 &&
          address < HF::Protocol::BROADCAST_ADDR)
      {
         base.unit0()->device_management()->next_address(address);
#ifdef HF_APP_EXT_REG

         if (HF::Application::Registration(true))
         {
            LOG(INFO) << "Enable Registration mode: SUCCESS" << NL;
         }
         else
         {
            LOG(WARN) << "[HANFUN] Enable Registration mode: FAIL" << NL;
         }

#endif
         LOG(INFO) << "Next Registration will have address : " << (int) address << NL;
      }
      else
      {
         LOG(ERROR) << "Registration impossible: address " << (int) address
                    << "  not available." << NL;
      }

      return;
   }

   LOG(APP) << usage(true) << NL;
}

deregister()

bool DeviceManagement::Server::deregister

(

uint16_t

address

)

De-register the device with the given address.

Parameters

[in]

address

address for the device to de-register.

Return values

<tt>true</tt>	if the device was de-registered;
<tt>false</tt>	otherwise.

Definition at line 136 of file base.cpp.

References HF::Protocol::BROADCAST_ADDR, and HF::Core::DeviceManagement::AbstractServer::deregister().

{
   if (address == 0 || address == HF::Protocol::BROADCAST_ADDR)
   {
      return false;
   }

   auto _entry = entry(address);

   if (_entry != nullptr)
   {
      HF::Core::DeviceManagement::Server<Entries>::deregister(_entry);
      return true;
   }

   return false;
}

Here is the call graph for this function:

from_json() [1/6]

void from_json	(	Json::Value &	node,
		HF::UID::UID *&	uid
	)

Create a new HF::UID::UID based on the fields present in the given Json::Value object.

Parameters

[in]	node	reference to the Json::Value containing the fields for the HF::UID::UID.
[out]	uid	reference to the pointer that will hold the created HF::UID::UID object of the correct type (NONE/RFPI/IPUI/MAC/URI).

from_json() [2/6]

void from_json	(	Json::Value &	node,
		HF::Common::Interface &	interface
	)

Fill a HF::Common::Interface from the given Json::Value object.

Parameters

[in]	node	reference to the Json::Value containing the fields for the HF::Common::Interface.
[out]	interface	reference to the HF::Common::Interface to update.

Definition at line 845 of file base.cpp.

{
   std::string role = node.get("role", "client").asString();

   if (role[0] == 's' || role[0] == 'S')
   {
      interface.role = HF::Interface::SERVER_ROLE;
   }
   else
   {
      interface.role = HF::Interface::CLIENT_ROLE;
   }

   interface.id = json_uid(node.get("id", "0x7FFF").asString());
}

from_json() [3/6]

void from_json	(	Json::Value &	node,
		HF::Core::DeviceManagement::Unit &	unit
	)

Fill a HF::Core::DeviceManagement::Unit from the given Json::Value object.

Parameters

[in]	node	reference to the Json::Value containing the fields for the HF::Core::DeviceManagement::Unit.
[out]	unit	reference to the HF::Core::DeviceManagement::Unit to update.

Definition at line 914 of file base.cpp.

{
   unit.id      = (uint8_t) node.get("id", HF::Protocol::BROADCAST_UNIT).asUInt();

   unit.profile = json_uid(node.get("profile", "0x7FFF").asString());

   for (unsigned i = 0; i < node["opts"].size(); i++)
   {
      unit.interfaces.push_back(0);
      from_json(node["opts"][i], unit.interfaces[i]);
   }
}

from_json() [4/6]

void from_json	(	Json::Value &	node,
		HF::Core::DeviceManagement::Device &	device
	)

Fill a HF::Core::DeviceManagement::Device from the given Json::Value object.

Parameters

[in]	node	reference to the Json::Value containing the fields for the HF::Core::DeviceManagement::Device.
[out]	device	reference to the HF::Core::DeviceManagement::Device to update.

Definition at line 934 of file base.cpp.

{
   dev.address = (uint16_t) node.get("address", HF::Protocol::BROADCAST_ADDR).asUInt();

   for (unsigned i = 0; i < node["units"].size(); i++)
   {
      dev.units.push_back(0);
      from_json(node["units"][i], dev.units[i]);
   }

   dev.emc = json_uid(node.get("emc", "0x0000").asString());

   from_json(node["uid"], dev.uid);
}

from_json() [5/6]

void from_json	(	Json::Value &	node,
		HF::Protocol::Address &	address
	)

Fill a HF::Protocol::Address from the given Json::Value object.

Parameters

[in]	node	reference to the Json::Value containing the fields for the HF::Protocol::Address.
[out]	address	reference to the HF::Protocol::Address to update.

Definition at line 956 of file base.cpp.

{
   addr.mod    = (uint16_t) node.get("mod", 0).asUInt();
   addr.device = (uint16_t) node.get("device", 0).asUInt();
   addr.unit   = (uint8_t) node.get("unit", 0).asUInt();
}

from_json() [6/6]

void from_json	(	Json::Value &	node,
		HF::Core::BindManagement::Entry &	entry
	)

Fill a HF::Core::BindManagement::Entry from the given Json::Value object.

Parameters

[in]	node	reference to the Json::Value containing the fields for the HF::Core::BindManagement::Entry.
[out]	entry	reference to the HF::Core::BindManagement::Entry to update.

Definition at line 970 of file base.cpp.

{
   from_json(node["src"], entry.source);
   from_json(node["dst"], entry.destination);
   from_json(node["itf"], entry.itf);
}

has_bind()

bool Base::has_bind	(	uint16_t	dev_addr_1,
		uint16_t	dev_addr_2
	)

Check if bind exists.

Parameters

[in]	dev_addr_1	HAN-FUN address of the first device.
[in]	dev_addr_2	HAN-FUN address of the second device.

Return values

true	if the binding exist;
false	otherwise.

Definition at line 613 of file base.cpp.

References HF::Interface::ON_OFF, and HF::Interface::SERVER_ROLE.

{
   HF::Protocol::Address source(dev_addr_1, 1);
   HF::Common::Interface itf(HF::Interface::ON_OFF, HF::Interface::SERVER_ROLE);
   HF::Protocol::Address destination(dev_addr_2, 1);

   return _unit0.bind_management()->entries().find(source, itf, destination) != nullptr;
}

Initialize()

void HF::Application::Initialize

(

HF::Transport::Layer &

transport

)

Initialize the application.

Parameters

[in]

transport

reference to the transport layer to use.

Definition at line 441 of file base_app.cpp.

{
   LOG(TRACE) << __PRETTY_FUNCTION__ << NL;

   transport.initialize();

   transport.add(&base);

   COMMAND_ADD(ListRegs);
   COMMAND_ADD(ListBinds);
   COMMAND_ADD(Register);
   COMMAND_ADD(Deregister);
   COMMAND_ADD(Bind);
   COMMAND_ADD(Unbind);
   COMMAND_ADD(GlobalBind);
   COMMAND_ADD(On);
   COMMAND_ADD(Off);
   COMMAND_ADD(Toggle);
   COMMAND_ADD(Raw);
   COMMAND_ADD(DevInfo);
   COMMAND_ADD(Links);

   Restore();
}

initialize()

void HF::Application::Transport::initialize ( )

virtual

Initialize the associated transport layer.

This method should initialize the transport layer using it's default values.

Reimplemented from HF::Transport::AbstractLayer.

Definition at line 474 of file transport.cpp.

References LOG, and HF::Application::Transport::socket.

{
   uv_loop_t *loop = uv_default_loop();

   uv_tcp_init(loop, &socket);

   socket.data = this;

   LOG(TRACE) << __PRETTY_FUNCTION__ << NL;

   struct sockaddr_in bind_addr = uv_ip4_addr("127.0.0.1", 8000);

   if (uv_tcp_bind(&socket, bind_addr) != 0)
   {
      print_error(loop->last_err);
      exit(-1);
   }

   if (uv_listen((uv_stream_t *) &socket, 128, on_connect) != 0)
   {
      print_error(loop->last_err);
      exit(-2);
   }
}

insert() [1/2]

void Entries::insert

(

const Device &

device

)

Insert a device management entry into the database.

This is used to add the entries when reading the configuration from the JSON database.

Parameters

[in]

device

device entry to add.

Definition at line 63 of file base.cpp.

{
   HF::Core::DeviceManagement::Entries::save(device);
}

insert() [2/2]

void Entries::insert

(

Entry &

entry

)

Insert a bind management entry into the database.

This is used to add the entries when reading the configuration from the JSON database.

Parameters

[in]

entry

device entry to add.

Definition at line 223 of file base.cpp.

{
   HF::Core::BindManagement::Entries::save(entry);
}

next_address()

uint16_t DeviceManagement::Server::next_address ( )

protectedvirtual

Return next available address for registering a device.

Returns

the address to use in the next registration.

Reimplemented from HF::Core::DeviceManagement::IServer.

Definition at line 115 of file base.cpp.

References HF::Protocol::BROADCAST_ADDR, and HF::Core::DeviceManagement::IServer::next_address().

{
   uint16_t result = _next_address;

   _next_address = HF::Protocol::BROADCAST_ADDR;

   if (result == HF::Protocol::BROADCAST_ADDR)
   {
      result = HF::Core::DeviceManagement::Server<Entries>::next_address();
   }

   return result;
}

Here is the call graph for this function:

off()

void SimpleLight::off ( HF::Protocol::Address &  source )

virtual

Callback that is called when a OFF_CMD message is received.

Parameters

[in]

source

device address that sent the command.

Reimplemented from HF::Interfaces::OnOff::Server.

Definition at line 66 of file node.cpp.

References LOG, and SimpleLight::off().

Referenced by SimpleLight::off().

{
   HF::Units::Unit<HF::Profiles::SimpleLight>::off(source);
   LOG(INFO) << ">>>>>>>>>>>>> SimpleLight : OFF <<<<<<<<<<<<<" << NL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

on()

void SimpleLight::on ( HF::Protocol::Address &  source )

virtual

Callback that is called when a ON_CMD message is received.

Parameters

[in]

source

device address that sent the command.

Reimplemented from HF::Interfaces::OnOff::Server.

Definition at line 60 of file node.cpp.

References LOG, and SimpleLight::on().

Referenced by SimpleLight::on().

{
   HF::Units::Unit<HF::Profiles::SimpleLight>::on(source);
   LOG(INFO) << ">>>>>>>>>>>>> SimpleLight : ON <<<<<<<<<<<<<" << NL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

print_error()

void print_error

(

uv_err_t

status

)

Print a user friendly string for given status code.

Parameters

[in]

status

status code to print.

Definition at line 227 of file transport.cpp.

References LOG.

{
   LOG(ERROR) << uv_err_name((uv_err_t &) status) << " - "
              << uv_strerror((uv_err_t &) status) << NL;
}

receive() [1/2]

void Node::receive ( HF::Protocol::Packet &  packet, HF::Common::ByteArray &  payload, uint16_t  offset  )

virtual

Callback to deliver a packet received from the transport layer.

Parameters

[in]	packet	reference to the received packet.
[in]	payload	reference a ByteArray containing the received data.
[in]	offset	offset from where the received data starts on the payload byte array buffer.

Reimplemented from HF::Devices::Node::Abstract< CoreServices >.

Definition at line 45 of file node.cpp.

References LOG, and Node::receive().

Referenced by Node::receive().

{
   LOG(DEBUG) << ">>>>>>>>>>>>> Message Received <<<<<<<<<<<<<" << NL;

   LOG(TRACE) << "Payload : " << payload << NL;

   LOG(DEBUG) << packet << NL;

   HF::Devices::Node::Abstract<HF::Devices::Node::DefaultUnit0>::receive(packet, payload, offset);
}

Here is the call graph for this function:

Here is the caller graph for this function:

receive() [2/2]

void Base::receive ( HF::Protocol::Packet &  packet, HF::Common::ByteArray &  payload, uint16_t  offset  )

virtual

Callback to deliver a packet received from the transport layer.

Parameters

[in]	packet	reference to the received packet.
[in]	payload	reference a ByteArray containing the received data.
[in]	offset	offset from where the received data starts on the payload byte array buffer.

Reimplemented from HF::Devices::Concentrator::AbstractBase.

Definition at line 595 of file base.cpp.

References LOG.

{
   LOG(DEBUG) << ">>>>>>>>>>>>> Message Received <<<<<<<<<<<<<" << NL;

   LOG(TRACE) << "Payload : " << payload << NL;

   LOG(DEBUG) << std::endl << packet << NL;

   HF::Devices::Concentrator::Abstract<Unit0>::receive(packet, payload, offset);
}

restore() [1/2]

void DeviceManagement::Server::restore

(

Json::Value

root

)

Restore the device entries from the JSON database.

Parameters

[in]

root

database root to start reading the entries.

Definition at line 184 of file base.cpp.

References LOG.

{
   LOG(INFO) << "Restoring registration entries ..." << NL;

   HF::Core::DeviceManagement::Device device;

   for (unsigned i = 0; i < root.size(); i++)
   {
      from_json(root[i], device);
      HF::Core::DeviceManagement::Server<Entries>::entries().insert(device);
   }
}

restore() [2/2]

void BindManagement::Server::restore

(

Json::Value

root

)

Restore the bind entries from the JSON database.

Parameters

[in]

root

database root to start reading the entries.

Definition at line 273 of file base.cpp.

References LOG.

{
   LOG(INFO) << "Restoring binding entries ..." << NL;

   for (unsigned i = 0; i < root.size(); i++)
   {
      HF::Core::BindManagement::Entry entry;
      from_json(root[i], entry);
      entries().insert(entry);
      LOG(TRACE) << "Bind Add : " << entry.source.device
                 << " -> " << entry.destination.device << NL;
   }
}

save() [1/2]

void DeviceManagement::Server::save

(

Json::Value &

root

)

Save the device entries into the JSON database.

Parameters

[in]

root

database root to start saving the entries.

Definition at line 161 of file base.cpp.

References LOG.

{
   LOG(INFO) << "Saving registration entries ..." << NL;

   unsigned i = 0;

   /* *INDENT-OFF* */
   for_each( entries ().begin (), entries ().end (),
             [&root, &i](HF::Core::DeviceManagement::Device &device)
   {
      to_json (device, root[i]);
      i++;
   });
   /* *INDENT-ON* */
}

save() [2/2]

void BindManagement::Server::save

(

Json::Value &

root

)

Save the bind entries into the JSON database.

Parameters

[in]

root

database root to start saving the entries.

Definition at line 250 of file base.cpp.

References LOG.

{
   LOG(INFO) << "Saving binding entries ..." << NL;

   unsigned i = 0;

   /* *INDENT-OFF* */
   for_each(entries().begin(), entries().end(),
            [&root, &i](const HF::Core::BindManagement::Entry &entry)
            {
               to_json (entry, root[i]);
               i++;
            });
   /* *INDENT-ON* */
}

send()

void HF::Application::Link::send ( HF::Common::ByteArray &  array )

virtual

Send the data in the given ByteArray using the link to the remote end-point.

Parameters

[in]

array

reference to the ByteArray containing the data to send.

Implements HF::Transport::Link.

Definition at line 588 of file transport.cpp.

References LOG.

{
   LOG(TRACE) << __PRETTY_FUNCTION__ << NL;

   msg_t msg(DATA_MSG);

   msg.data = array;

   send_message((uv_stream_t *) stream, msg);
}

to_json() [1/6]

void to_json	(	HF::UID::UID *	uid,
		Json::Value &	node
	)

Serialize a HF::UID::UID pointer to the given Json::Value.

Parameters

[in]	uid	pointer to the HF::UID::UID to serialize to JSON.
[out]	node	reference to the Json::Value to place the serialization result in.

to_json() [2/6]

void to_json	(	const HF::Common::Interface &	interface,
		Json::Value &	node
	)

Serialize a HF::Common::Interface to the given Json::Value.

Parameters

[in]	interface	reference to the HF::Common::Interface to serialize to JSON.
[out]	node	reference to the Json::Value to place the serialization result in.

Definition at line 702 of file base.cpp.

{
   if (interface.role == HF::Interface::SERVER_ROLE)
   {
      node["role"] = "server";
   }
   else
   {
      node["role"] = "client";
   }

   node["id"] = json_uid(interface.id);
}

to_json() [3/6]

void to_json	(	const HF::Core::DeviceManagement::Unit &	unit,
		Json::Value &	node
	)

Serialize a HF::Core::DeviceManagement::Unit to the given Json::Value.

Parameters

[in]	unit	reference to the HF::Core::DeviceManagement::Unit to serialize to JSON.
[out]	node	reference to the Json::Value to place the serialization result in.

Definition at line 777 of file base.cpp.

{
   node["id"]      = unit.id;

   node["profile"] = json_uid(unit.profile);

   for (unsigned i = 0; i < unit.interfaces.size(); i++)
   {
      to_json(unit.interfaces[i], node["opts"][i]);
   }
}

to_json() [4/6]

void to_json	(	const HF::Core::DeviceManagement::Device &	device,
		Json::Value &	node
	)

Serialize a HF::Core::DeviceManagement::Device to the given Json::Value.

Parameters

[in]	device	reference to the HF::Core::DeviceManagement::Device to serialize to JSON.
[out]	node	reference to the Json::Value to place the serialization result in.

Definition at line 796 of file base.cpp.

{
   node["address"] = device.address;

   for (unsigned i = 0; i < device.units.size(); i++)
   {
      to_json(device.units[i], node["units"][i]);
   }

   node["emc"] = json_uid(device.emc);

   to_json(device.uid, node["uid"]);
}

to_json() [5/6]

void to_json	(	const HF::Protocol::Address &	address,
		Json::Value &	node
	)

Serialize a HF::Protocol::Address to the given Json::Value.

Parameters

[in]	address	reference to the HF::Protocol::Address to serialize to JSON.
[out]	node	reference to the Json::Value to place the serialization result in.

Definition at line 817 of file base.cpp.

{
   node["mod"]    = (int) address.mod;
   node["device"] = (int) address.device;
   node["unit"]   = (int) address.unit;
}

to_json() [6/6]

void to_json	(	const HF::Core::BindManagement::Entry &	entry,
		Json::Value &	node
	)

Serialize a HF::Core::BindManagement::Entry to the given Json::Value.

Parameters

[in]	entry	reference to the HF::Core::BindManagement::Entry to serialize to JSON.
[out]	node	reference to the Json::Value to place the serialization result in.

Definition at line 831 of file base.cpp.

{
   to_json(entry.source, node["src"]);
   to_json(entry.destination, node["dst"]);
   to_json(entry.itf, node["itf"]);
}

toggle()

void SimpleLight::toggle ( HF::Protocol::Address &  source )

virtual

Callback that is called when a TOGGLE_CMD message is received.

Parameters

[in]

source

device address that sent the command.

Reimplemented from HF::Interfaces::OnOff::Server.

Definition at line 72 of file node.cpp.

References LOG, and SimpleLight::toggle().

Referenced by SimpleLight::toggle().

{
   HF::Units::Unit<HF::Profiles::SimpleLight>::toggle(source);
   LOG(INFO) << ">>>>>>>>>>>>> SimpleLight : TOGGLE <<<<<<<<<<<<<" << NL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

unbind()

bool Base::unbind	(	uint16_t	dev_addr_1,
		uint16_t	dev_addr_2
	)

Remove the binding entry for the given devices.

If the bind does not exist, nothing changes.

Parameters

[in]	dev_addr_1	HAN-FUN address of the first device.
[in]	dev_addr_2	HAN-FUN address of the second device.

Return values

true	if the bind entry was found and removed,
false	otherwise.

Definition at line 667 of file base.cpp.

References HF::Common::OK, HF::Interface::ON_OFF, and HF::Interface::SERVER_ROLE.

{
   HF::Protocol::Address source(dev_addr_1, 1);
   HF::Common::Interface itf(HF::Interface::ON_OFF, HF::Interface::SERVER_ROLE);
   HF::Protocol::Address destination(dev_addr_2, 1);

   return _unit0.bind_management()->remove(source, destination, itf) == HF::Common::Result::OK;
}