openD unified API  1.0.0
openD HAN-FUN API portable part

Modules

 Interfaces
 
 Profiles
 

Classes

struct  DeviceManagementNode
 
struct  Unit0Node
 
struct  SimpleSwitch
 
struct  SimpleReed
 
class  SimpleLight
 
struct  Device
 

Functions

openD_status_t openD_hanfunApi_pp_init ()
 openD HAN-FUN API initialization. More...
 
openD_status_t openD_hanfunApi_pp_devMgmtRequest (openD_hanfunApi_devMgmtReq_t *hMgmtRequest, uint16_t address=0)
 openD HAN-FUN API device management request. More...
 
openD_status_t openD_hanfunApi_pp_profileRequest (openD_hanfunApi_profileReq_t *hProfileRequest)
 openD HAN-FUN API profile request. More...
 
openD_status_t opend_hanfun_registerDevice ()
 openD HANFUN register device. More...
 
openD_status_t opend_hanfun_createProfile (openD_hanfunApi_profile_t opend_profile, uint8_t id)
 openD HANFUN create profile. More...
 

Detailed Description

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

Function Documentation

◆ opend_hanfun_createProfile()

openD_status_t opend_hanfun_createProfile ( openD_hanfunApi_profile_t  opend_profile,
uint8_t  id 
)

openD HANFUN create profile.

Create a profile for the node device.

Parameters
opend_profileEnum of the HANFUN profile.
idID of the HANFUN profile.
Return values
Statusof the operation (openD_status_t).

◆ opend_hanfun_registerDevice()

openD_status_t opend_hanfun_registerDevice ( )

openD HANFUN register device.

Send a register device to the concentrator. This function is triggered by an indication after the ULE registration is finished.

Return values
Statusof the operation (openD_status_t).

◆ openD_hanfunApi_pp_devMgmtRequest()

openD_status_t openD_hanfunApi_pp_devMgmtRequest ( openD_hanfunApi_devMgmtReq_t hMgmtRequest,
uint16_t  address = 0 
)

openD HAN-FUN API device management request.

Device management requests of the different profiles.

Parameters
hMgmtRequestPointer of the HAN-FUN API request structure (openD_hanfunApi_devMgmtReq_t).
addressAddress to send the request.
Return values
Statusof the operation (openD_status_t).

◆ openD_hanfunApi_pp_init()

openD_status_t openD_hanfunApi_pp_init ( )

openD HAN-FUN API initialization.

Initialization of the hanfun api with the iwu.

Return values
Statusof the operation (openD_status_t).

◆ openD_hanfunApi_pp_profileRequest()

openD_status_t openD_hanfunApi_pp_profileRequest ( openD_hanfunApi_profileReq_t hProfileRequest)

openD HAN-FUN API profile request.

Profile request with different services.

Parameters
hProfileRequestPointer of the HAN-FUN API request structure (openD_hanfunApi_profileReq_t).
Return values
Statusof the operation (openD_status_t).