Classes
struct	openD_mgmtApiPrimitives

struct	mgmtApiInd_keepAlive

struct	openD_mgmtApiReq

union	openD_mgmtApiReq.param

struct	openD_mgmtApiCfm

struct	openD_mgmtApiInd

union	openD_mgmtApiInd.param

Macros
#define	__OPEND_MGMT_API_H__

#define	__OPEND_MGMT_TYPES_H__

Typedefs
typedef struct openD_mgmtApiPrimitives	openD_mgmtApiPrimitives_t

typedef enum openD_mgmtApi_service	openD_mgmtApi_service_t

typedef enum openD_mgmtApi_dectMode	openD_mgmtApi_dectMode_t

typedef struct mgmtApiInd_keepAlive	mgmtApiInd_keepAlive_t

typedef struct openD_mgmtApiReq	openD_mgmtApiReq_t

typedef struct openD_mgmtApiCfm	openD_mgmtApiCfm_t

typedef struct openD_mgmtApiInd	openD_mgmtApiInd_t

Enumerations
enum	openD_mgmtApi_service { OPEND_MGMTAPI_INIT, OPEND_MGMTAPI_DECTMODE, OPEND_MGMTAPI_POWER_DOWN_CTRL, OPEND_MGMTAPI_WAKE_UP, OPEND_MGMTAPI_KEEP_ALIVE, OPEND_MGMTAPI_FORCE_NVM_DEFAULT }

enum	openD_mgmtApi_dectMode { OPEND_MGMTAPI_DECTMODE_FP, OPEND_MGMTAPI_DECTMODE_PP, OPEND_MGMTAPI_DECTMODE_HF, OPEND_MGMTAPI_DECTMODE_SIXLOWPAN }

Functions
openD_status_t	openD_mgmtApi_init (openD_mgmtApiPrimitives_t *mPrimitives)
	openD management API initialization. More...

openD_status_t	openD_mgmtApi_request (openD_mgmtApiReq_t *mRequest)
	openD management API request. More...

Detailed Description

This module specifies the management API of openD connect.

This file defines the management types of openD connect.

Class Documentation

◆ mgmtApiInd_keepAlive

struct mgmtApiInd_keepAlive

openD MgmtApi indication keepAlive structure.

Class Members
pmid_t	pmid	Portable part MAC Identity (PMID).

◆ openD_mgmtApiReq

struct openD_mgmtApiReq

openD MgmtApi request structure.

Class Members
union openD_mgmtApiReq	param	openD MgmtApi request parameters.
openD_mgmtApi_service_t	service	MgmtApi request service.

◆ openD_mgmtApiReq.param

union openD_mgmtApiReq.param

openD MgmtApi request parameters.

Class Members
openD_mgmtApi_dectMode_t	dectMode	MgmtApi parameters for a dectMode request.

◆ openD_mgmtApiCfm

struct openD_mgmtApiCfm

openD MgmtApi confirm structure.

Class Members
openD_mgmtApi_service_t	service	MgmtApi confirm service.
openD_status_t	status	MgmtApi service status.

◆ openD_mgmtApiInd

struct openD_mgmtApiInd

openD MgmtApi indication structure.

Class Members
union openD_mgmtApiInd	param	openD MgmtApi indication parameters.
openD_mgmtApi_service_t	service	MgmtApi indication service.

◆ openD_mgmtApiInd.param

union openD_mgmtApiInd.param

openD MgmtApi indication parameters.

Class Members
mgmtApiInd_keepAlive_t	keepAlive	MgmtApi parameter for a keepAlive indication.

Macro Definition Documentation

◆ __OPEND_MGMT_API_H__

#define __OPEND_MGMT_API_H__

◆ __OPEND_MGMT_TYPES_H__

#define __OPEND_MGMT_TYPES_H__

Typedef Documentation

◆ mgmtApiInd_keepAlive_t

typedef struct mgmtApiInd_keepAlive mgmtApiInd_keepAlive_t

openD MgmtApi indication keepAlive structure.

◆ openD_mgmtApi_dectMode_t

typedef enum openD_mgmtApi_dectMode openD_mgmtApi_dectMode_t

openD MgmtApi DectModes.

◆ openD_mgmtApi_service_t

typedef enum openD_mgmtApi_service openD_mgmtApi_service_t

openD MgmtApi services.

◆ openD_mgmtApiCfm_t

typedef struct openD_mgmtApiCfm openD_mgmtApiCfm_t

openD MgmtApi confirm structure.

◆ openD_mgmtApiInd_t

typedef struct openD_mgmtApiInd openD_mgmtApiInd_t

openD MgmtApi indication structure.

◆ openD_mgmtApiPrimitives_t

typedef struct openD_mgmtApiPrimitives openD_mgmtApiPrimitives_t

openD MgmtApi primitives structure.

◆ openD_mgmtApiReq_t

typedef struct openD_mgmtApiReq openD_mgmtApiReq_t

openD MgmtApi request structure.

Enumeration Type Documentation

◆ openD_mgmtApi_dectMode

enum openD_mgmtApi_dectMode

openD MgmtApi DectModes.

Enumerator
OPEND_MGMTAPI_DECTMODE_FP	DectMode fix part.
OPEND_MGMTAPI_DECTMODE_PP	DectMode portable part.
OPEND_MGMTAPI_DECTMODE_HF	DectMode HAN-FUN.
OPEND_MGMTAPI_DECTMODE_SIXLOWPAN	DectMode 6LoWPAN.

◆ openD_mgmtApi_service

enum openD_mgmtApi_service

openD MgmtApi services.

Enumerator
OPEND_MGMTAPI_INIT	Initialization.
OPEND_MGMTAPI_DECTMODE	DectMode.
OPEND_MGMTAPI_POWER_DOWN_CTRL	Power down control.
OPEND_MGMTAPI_WAKE_UP	Wake up.
OPEND_MGMTAPI_KEEP_ALIVE	Keep alive indication.
OPEND_MGMTAPI_FORCE_NVM_DEFAULT	Force NVM default.

Function Documentation

◆ openD_mgmtApi_init()

openD_status_t openD_mgmtApi_init ( openD_mgmtApiPrimitives_t * mPrimitives )

openD management API initialization.

Parameters

mPrimitives Pointer of the management API primitives structure (openD_mgmtApiPrimitives_t).

Return values

Status of the operation (openD_status_t).

◆ openD_mgmtApi_request()

openD_status_t openD_mgmtApi_request ( openD_mgmtApiReq_t * mRequest )

openD management API request.