FP Struct Reference

#include <opend_hanfun_api_fp.h>

Inheritance diagram for FP:

Public Member Functions
virtual	~FP ()
void	receive (HF::Protocol::Packet &packet, HF::Common::ByteArray &payload, uint16_t offset)
	Receive message. More...
std::forward_list< HF::Transport::Link * > &	links ()
	HANFUN iwu links. More...
bool	has_bind (uint16_t dev_addr_1, uint16_t dev_addr_2)
	Has bind. More...
uint8_t	bind (uint16_t dev_addr_1, uint16_t dev_addr_2)
	Bind. More...
bool	unbind (uint16_t dev_addr_1, uint16_t dev_addr_2)
	Bind. More...

Static Public Member Functions
static FP *	instance ()
	Create FP instance. More...

Public Attributes
Commands::Unit	commands

Detailed Description

A struct for the HANFUN fix part.

Constructor & Destructor Documentation

~FP()

virtual FP::~FP ( )

inlinevirtual

Member Function Documentation

bind()

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

Bind.

Bind two devices.

Parameters

dev_addr_1	Address of the first device.
dev_addr_2	Address of the second device.

Return values

Error

handling value of the operation.

has_bind()

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

Has bind.

Check if the devices have a bind.

Parameters

dev_addr_1	Address of the first device.
dev_addr_2	Address of the second device.

Return values

Status

of the operation.

instance()

static FP* FP::instance ( )

static

Create FP instance.

Create a FP object for the concentrator FP with singleton.

Return values

FP	object singleton instance.

links()

std::forward_list<HF::Transport::Link *>& FP::links ( )

inline

HANFUN iwu links.

Provide the HANFUN iwu links.

Return values

List	of the current links.

receive()

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

Receive message.

Handle the received HANFUN message.

Parameters

packet	Received HANFUN packet.
payload	Received payload.
offset	Offset of the received message.

unbind()

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

Bind.

Bind two devices.

Parameters

dev_addr_1	Address of the first device.
dev_addr_2	Address of the second device.

Return values

Error

handling value of the operation.

Member Data Documentation

commands

Commands::Unit FP::commands

---

The documentation for this struct was generated from the following file:

• src/opend/opend_hanfun_api_fp.h