openD HAN-FUN API fixed part

Modules
	Interfaces
	Profiles

Namespaces
	DeviceManagement
	BindManagement
	Commands

Classes
struct	FP

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

Functions
openD_status_t	openD_hanfunApi_fp_init (HF::Transport::Layer *transport)
	openD HAN-FUN API initialization. More...
openD_status_t	openD_hanfunApi_fp_devMgmtRequest (openD_hanfunApi_devMgmtReq_t *hMgmtRequest, uint16_t address=0, uint8_t dectMode=0)
	openD HAN-FUN API device management request. More...
openD_status_t	openD_hanfunApi_fp_bindMgmtRequest (openD_hanfunApi_bindMgmtReq_t *hBindRequest, uint16_t address1=0, uint16_t address2=0)
	openD HAN-FUN API bind management request. More...
openD_status_t	openD_hanfunApi_fp_profileRequest (openD_hanfunApi_profileReq_t *hProfileRequest, uint16_t address=0, uint16_t unit=0)
	openD HAN-FUN API profile request. More...

Detailed Description

This module specifies the HAN-FUN API of openD connect.

Typedef Documentation

Unit0

typedef HF::Devices::Concentrator::Unit0<HF::Core::DeviceInformation::Server, DeviceManagement::Server, HF::Core::AttributeReporting::Server, BindManagement::Server> Unit0

Macro for Unit 0 with inheritance of the used templates.

Function Documentation

openD_hanfunApi_fp_bindMgmtRequest()

openD_status_t openD_hanfunApi_fp_bindMgmtRequest	(	openD_hanfunApi_bindMgmtReq_t *	hBindRequest,
		uint16_t	address1 = 0,
		uint16_t	address2 = 0
	)

openD HAN-FUN API bind management request.

Bind management request with different services. This can be used to create binds of devices.

Parameters

hBindRequest	Pointer of the HAN-FUN API request structure (openD_hanfunApi_bindMgmtReq_t).
address1	First device address to bind.
address2	Second device address to bind.

Return values

Status

of the operation (openD_status_t).

openD_hanfunApi_fp_devMgmtRequest()

openD_status_t openD_hanfunApi_fp_devMgmtRequest	(	openD_hanfunApi_devMgmtReq_t *	hMgmtRequest,
		uint16_t	address = 0,
		uint8_t	dectMode = 0
	)

openD HAN-FUN API device management request.

Sends a device management request to a device. You can choose between different services. For example, you can deregister a device.

Parameters

hMgmtRequest	Pointer of the HAN-FUN API request structure (openD_hanfunApi_devMgmtReq_t).
address	Device address to send the request.
address	Second device address to bind.
dectMode	DECT mode.

Return values

Status

of the operation (openD_status_t).

openD_hanfunApi_fp_init()

openD_status_t openD_hanfunApi_fp_init

(

HF::Transport::Layer *

transport

)

openD HAN-FUN API initialization.

Initialization of the hanfun api with the iwu.

Parameters

transport

Pointer of the transport iwu for the concentrator.

Return values

Status

of the operation (openD_status_t).

openD_hanfunApi_fp_profileRequest()

openD_status_t openD_hanfunApi_fp_profileRequest	(	openD_hanfunApi_profileReq_t *	hProfileRequest,
		uint16_t	address = 0,
		uint16_t	unit = 0
	)

openD HAN-FUN API profile request.

Sends a profile request to a device. You can choose between different profiles, each with different services. For example, a led of a registered device can be switched on or off.

Parameters

hProfileRequest	Pointer of the HAN-FUN API request structure (openD_hanfunApi_profileReq_t).
address	Address of the device to send the request.
unit	Unit of the device to send the request.

Return values

Status

of the operation (openD_status_t).