Developer World
Spresense SDK Library v3.3.0-375c679
Ltelwm2m_func_beforeradioon
Collaboration diagram for Ltelwm2m_func_beforeradioon:

Functions before Radio ON

API functions which can effect before lte_radio_on()

Those functions can be called just after lte_power_on() until before lte_radio_on().

int lte_setm2m_endpointname (FAR char *name)
 Set endpoint name. More...
 
int lte_getm2m_endpointname (FAR char *name, int len)
 Get endpoint name. More...
 
int lte_getm2m_servernum (void)
 Get Server num. More...
 
int lte_setm2m_serverinfo (FAR struct lwm2mstub_serverinfo_s *info, int id)
 Server configuration. More...
 
int lte_getm2m_serverinfo (FAR struct lwm2mstub_serverinfo_s *info, int id)
 Get server configuration. More...
 
int lte_getm2m_enabled_objectnum (void)
 Get enabled objects number. More...
 
int lte_getm2m_enabled_objects (FAR uint16_t *objids, int objnum)
 Get object IDs of currently active objects. More...
 
int lte_enablem2m_objects (FAR uint16_t *objids, int objnum)
 Enable objects. More...
 
int lte_getm2m_objresourcenum (uint16_t objid)
 Get resource number on the object. More...
 
int lte_getm2m_objresourceinfo (uint16_t objids, int res_num, FAR struct lwm2mstub_resource_s *reses)
 Get the information of resources on the object. More...
 
int lte_setm2m_objectdefinition (uint16_t objids, int res_num, FAR struct lwm2mstub_resource_s *reses)
 Configure the resources of the object. More...
 
bool lte_getm2m_qmode (void)
 Get current Queue mode of LwM2M. More...
 
int lte_setm2m_qmode (bool en)
 Set Queue mode of LwM2M. More...
 
int lte_apply_m2msetting (void)
 Activate all configurations. More...
 

Detailed Description

Function Documentation

◆ lte_setm2m_endpointname()

int lte_setm2m_endpointname ( FAR char *  name)

Set endpoint name.

To set the device endpoint name.

Parameters
[in]nameEndpoint name to set. This is ASCII character array terminated by '\0'
Return values
OKSetting is done successfully
non-OKAny error is occurred

◆ lte_getm2m_endpointname()

int lte_getm2m_endpointname ( FAR char *  name,
int  len 
)

Get endpoint name.

Get the device endpoint name.

Parameters
[out]namepointer to store the endpoint name.
[in]lenLength of the memory of name in bytes.
Return values
OKSetting is done successfully
non-OKAny error is occurred

◆ lte_getm2m_servernum()

int lte_getm2m_servernum ( void  )

Get Server num.

Get number of servers.

Return values
>=0Server number
<0Any error is occurred

◆ lte_setm2m_serverinfo()

int lte_setm2m_serverinfo ( FAR struct lwm2mstub_serverinfo_s info,
int  id 
)

Server configuration.

Configure the settings according to the information on the server side.

Parameters
[in]infoServer information to set
[in]idServer ID. Which is an ID from 0 to the number obtained by lte_getm2m_servernum(). Currently only 0 is supported.
Return values
OKConfiguration is done successfully
non-OKAny error is occurred

◆ lte_getm2m_serverinfo()

int lte_getm2m_serverinfo ( FAR struct lwm2mstub_serverinfo_s info,
int  id 
)

Get server configuration.

Configure the settings according to the information on the server side.

Parameters
[out]infoServer information
[in]idServer ID. Which is an ID from 0 to the number obtained by lte_getm2m_servernum(). Currently only 0 is supported.
Return values
OKConfiguration is done successfully
non-OKAny error is occurred

◆ lte_getm2m_enabled_objectnum()

int lte_getm2m_enabled_objectnum ( void  )

Get enabled objects number.

Obtaining the number of currently active objects.

Return values
>=0Objects number
<0Any error is occurred

◆ lte_getm2m_enabled_objects()

int lte_getm2m_enabled_objects ( FAR uint16_t *  objids,
int  objnum 
)

Get object IDs of currently active objects.

Obtaining object IDs of currently active objects.

Parameters
[out]objidsArray to store object IDs
[in]objnumSize of objids array
Return values
>=0Actual number of object IDs
<0Any error is occurred

◆ lte_enablem2m_objects()

int lte_enablem2m_objects ( FAR uint16_t *  objids,
int  objnum 
)

Enable objects.

Activate the specified Object IDs

Parameters
[in]objidsArray to indicate object IDs to enable
[in]objnumSize of objids array
Return values
OKOperation is done successfully
non-OKAny error is occurred

◆ lte_getm2m_objresourcenum()

int lte_getm2m_objresourcenum ( uint16_t  objid)

Get resource number on the object.

Obtains the number of resources that the specified Object has.

Parameters
[in]objidObject ID
Return values
>=0The number of resources
<0Any error is occurred

◆ lte_getm2m_objresourceinfo()

int lte_getm2m_objresourceinfo ( uint16_t  objids,
int  res_num,
FAR struct lwm2mstub_resource_s reses 
)

Get the information of resources on the object.

Obtains the information of resources that the specified Object has.

Parameters
[in]objidsObject ID
[in]res_numArray size of reses
[in]resesArray of resources information to store
Return values
OKOperation is done successfully
non-OKAny error is occurred

◆ lte_setm2m_objectdefinition()

int lte_setm2m_objectdefinition ( uint16_t  objids,
int  res_num,
FAR struct lwm2mstub_resource_s reses 
)

Configure the resources of the object.

Configure the resources specified the object.

Parameters
[in]objidsObject ID
[in]res_numArray size of reses
[in]resesArray of resources to configure
Return values
OKOperation is done successfully
non-OKAny error is occurred

◆ lte_getm2m_qmode()

bool lte_getm2m_qmode ( void  )

Get current Queue mode of LwM2M.

Get current Quene mode setting.

Return values
trueQueue mode is enabled
falseQueue mode is disabled

◆ lte_setm2m_qmode()

int lte_setm2m_qmode ( bool  en)

Set Queue mode of LwM2M.

Set Quene mode setting.

Parameters
[in]enQueue mode enable.
Return values
OKOperation is done successfully
non-OKAny error is occurred

◆ lte_apply_m2msetting()

int lte_apply_m2msetting ( void  )

Activate all configurations.

Configuration functions in Ltelwm2m_func_beforeradioon group is not effected before this function is called.

Return values
OKOperation is done successfully
non-OKAny error is occurred