Ltelwm2m_func_afterradioon

Collaboration diagram for Ltelwm2m_func_afterradioon:

Variables
int	res_id
int	operation
int	inst_type
int	data_type
int	handl
int	object_id
int	object_inst
int	res_id
int	res_inst
uint8_t	valid_mask
unsigned int	min_period
unsigned int	max_period
double	gt_cond
double	lt_cond
double	step_val
int	object_inst
int	state
bool	bootstrap
bool	nonip
int	security_mode
uint32_t	lifetime
char	server_uri [LWM2MSTUB_MAX_SERVER_NAME]
char	device_id [LWM2MSTUB_MAX_DEVID]
char	security_key [LWM2MSTUB_MAX_SEQKEY]

Functions after Radio ON
API functions which can effect after lte_radio_on() Those functions can be called after lte_radio_on().
int	lte_m2m_connection (int cmd)
	Control connection to server. More...
int	lte_set_report_m2mwrite (lwm2mstub_write_cb_t cb)
	Register callback function pointer for write request. More...
int	lte_set_report_m2mread (lwm2mstub_read_cb_t cb)
	Register callback function pointer for read request. More...
int	lte_set_report_m2mexec (lwm2mstub_exec_cb_t cb)
	Register callback function pointer for execute request. More...
int	lte_set_report_m2movstart (lwm2mstub_ovstart_cb_t cb)
	Register callback function pointer for observation start request. More...
int	lte_set_report_m2movstop (lwm2mstub_ovstop_cb_t cb)
	Register callback function pointer for observation stop request. More...
int	lte_set_report_m2moperation (lwm2mstub_operation_cb_t cb)
	Register callback function pointer for server operation. More...
int	lte_set_report_m2mfwupdate (lwm2mstub_fwupstate_cb_t cb)
	Register callback function pointer for firmware update status. More...
int	lte_m2m_readresponse (int seq_no, FAR struct lwm2mstub_instance_s *inst, int resp, FAR char *readvalue, int len)
	Response result of read request to the server. More...
int	lte_m2m_writeresponse (int seq_no, FAR struct lwm2mstub_instance_s *inst, int resp)
	Response result of write request to the server. More...
int	lte_m2m_executeresp (int seq_no, FAR struct lwm2mstub_instance_s *inst, int resp)
	Response result of execute request to the server. More...
int	lte_m2m_observeresp (int seq_no, int resp)
	Response result of observation start/stop request to the server. More...

Detailed Description

Function Documentation

lte_m2m_connection()

int lte_m2m_connection

(

int

cmd

)

Control connection to server.

Connection control to the server which is configured by lte_setm2m_serverinfo()

Parameters

[in]

cmd

Connection command. Refer to Ltelwm2m_macro_regcmd for more details.

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_set_report_m2mwrite()

int lte_set_report_m2mwrite

(

lwm2mstub_write_cb_t

cb

)

Register callback function pointer for write request.

Register callback function to get notification of write request from a server

Parameters

[in]

cb

Callback function pointer which is implemented by user

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_set_report_m2mread()

int lte_set_report_m2mread

(

lwm2mstub_read_cb_t

cb

)

Register callback function pointer for read request.

Register callback function to get notification of read request from a server

Parameters

[in]

cb

Callback function pointer which is implemented by user

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_set_report_m2mexec()

int lte_set_report_m2mexec

(

lwm2mstub_exec_cb_t

cb

)

Register callback function pointer for execute request.

Register callback function to get notification of execute request from a server

Parameters

[in]

cb

Callback function pointer which is implemented by user

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_set_report_m2movstart()

int lte_set_report_m2movstart

(

lwm2mstub_ovstart_cb_t

cb

)

Register callback function pointer for observation start request.

Register callback function to get notification of observation start request from a server

Parameters

[in]

cb

Callback function pointer which is implemented by user

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_set_report_m2movstop()

int lte_set_report_m2movstop

(

lwm2mstub_ovstop_cb_t

cb

)

Register callback function pointer for observation stop request.

Register callback function to get notification of observation stop request from a server

Parameters

[in]

cb

Callback function pointer which is implemented by user

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_set_report_m2moperation()

int lte_set_report_m2moperation

(

lwm2mstub_operation_cb_t

cb

)

Register callback function pointer for server operation.

Register callback function to get briefly notification of server operation

Parameters

[in]

cb

Callback function pointer which is implemented by user

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_set_report_m2mfwupdate()

int lte_set_report_m2mfwupdate

(

lwm2mstub_fwupstate_cb_t

cb

)

Register callback function pointer for firmware update status.

Register callback function to get notification of firmware update status from the modem

Parameters

[in]

cb

Callback function pointer which is implemented by user

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_m2m_readresponse()

int lte_m2m_readresponse	(	int	seq_no,
		FAR struct lwm2mstub_instance_s *	inst,
		int	resp,
		FAR char *	readvalue,
		int	len
	)

Response result of read request to the server.

Send response of result of read request to the server. Basically this function is called in lwm2mstub_read_cb_t callback function.

Parameters

[in]	seq_no	Sequence number provided on an argument as seq_no in lwm2mstub_read_cb_t
[in]	inst	Resource URI to respond. Basically this should be the same as inst argument on lwm2mstub_read_cb_t
[in]	resp	Response code. Refer to Ltelwm2m_macro_serverop for more details.
[in]	value	Read value as string data to send.
[in]	len	Length of the value.

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_m2m_writeresponse()

int lte_m2m_writeresponse	(	int	seq_no,
		FAR struct lwm2mstub_instance_s *	inst,
		int	resp
	)

Response result of write request to the server.

Send response of result of write request to the server. Basically this function is called in lwm2mstub_write_cb_t callback function.

Parameters

[in]	seq_no	Sequence number provided on an argument as seq_no in lwm2mstub_write_cb_t
[in]	inst	Resource URI to respond. Basically this should be the same as inst argument on lwm2mstub_write_cb_t
[in]	resp	Response code. Refer to Ltelwm2m_macro_serverop for more details.

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_m2m_executeresp()

int lte_m2m_executeresp	(	int	seq_no,
		FAR struct lwm2mstub_instance_s *	inst,
		int	resp
	)

Response result of execute request to the server.

Send response of result of execute request to the server. Basically this function is called in lwm2mstub_exec_cb_t callback function.

Parameters

[in]	seq_no	Sequence number provided on an argument as seq_no in lwm2mstub_exec_cb_t
[in]	inst	Resource URI to respond. Basically this should be the same as inst argument on lwm2mstub_exec_cb_t
[in]	resp	Response code. Refer to Ltelwm2m_macro_serverop for more details.

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

lte_m2m_observeresp()

int lte_m2m_observeresp	(	int	seq_no,
		int	resp
	)

Response result of observation start/stop request to the server.

Send response of result of observation start/stop request to the server. Basically this function is called in lwm2mstub_obstart_cb_t or lwm2mstub_ovstop_cb_t callback function.

Parameters

[in]	seq_no	Sequence number provided on an argument as seq_no in lwm2mstub_ovstart_cb_t or lwm2mstub_ovstop_cb_t
[in]	resp	Response code. Refer to Ltelwm2m_macro_serverop for more details.

Return values

OK	Operation is done successfully
non-OK	Any error is occurred

Variable Documentation

res_id [1/2]

int res_id

Resource id

operation

int operation

Operation mode: refer to Ltelwm2m_macro_resopmode more details

inst_type

int inst_type

Instance type: refer to Ltelwm2m_macro_resinsttype more details

data_type

int data_type

Data type: refer to Ltelwm2m_macro_resdatatype more details

handl

int handl

Handle side: refer to Ltelwm2m_macro_reshandle more details

object_id

int object_id

Object ID

object_inst [1/2]

int object_inst

Object Instance number

res_id [2/2]

int res_id

Resource ID

res_inst

int res_inst

Resource instance number

valid_mask

uint8_t valid_mask

Bit map to indicate valid parameters: refer to Ltelwm2m_macro_condvalid for more details

min_period

unsigned int min_period

Min period seconds

max_period

unsigned int max_period

Max period seconds

gt_cond

double gt_cond

Grater than condition

lt_cond

double lt_cond

Less than condition

step_val

double step_val

Step value

object_inst [2/2]

int object_inst

Server object instance number. Usually set to 0

state

int state

Current server status: Refer to Ltelwm2m_macro_serverstat for more details

bootstrap

bool bootstrap

Set true, when it uses bootstrap server

nonip

bool nonip

Set true, when Non IP like NIDD is used

security_mode

int security_mode

Security type: Refer to Ltelwm2m_macro_seqmode for more details

lifetime

uint32_t lifetime

Lifetime which is stored into /1/x/1 resource as a default value.

server_uri

char server_uri[LWM2MSTUB_MAX_SERVER_NAME]

Server URI

device_id

char device_id[LWM2MSTUB_MAX_DEVID]

Device ID

security_key

char security_key[LWM2MSTUB_MAX_SEQKEY]

Security key