API for configuring and manipulating NB IoT 2 Click driver. More...

Topics
	NB IoT 2 Device Settings
	Settings for registers of NB IoT 2 Click driver.

	NB IoT 2 MikroBUS Map
	MikroBUS pin mapping of NB IoT 2 Click driver.

Functions
void	nbiot2_cfg_setup (nbiot2_cfg_t *cfg)
	NB IoT 2 configuration object setup function.

err_t	nbiot2_init (nbiot2_t ctx, nbiot2_cfg_t cfg)
	NB IoT 2 initialization function.

err_t	nbiot2_generic_write (nbiot2_t ctx, char data_in, uint16_t len)
	NB IoT 2 data writing function.

err_t	nbiot2_generic_read (nbiot2_t ctx, char data_out, uint16_t len)
	NB IoT 2 data reading function.

void	nbiot2_set_rst_pin_state (nbiot2_t *ctx, uint8_t state)
	NB IoT 2 sets state of the RST pin.

void	nbiot2_set_wup_pin_state (nbiot2_t *ctx, uint8_t state)
	NB IoT 2 sets state of the WUP pin.

void	nbiot2_hw_reset (nbiot2_t *ctx)
	NB IoT 2 hardware reset function.

void	nbiot2_send_cmd (nbiot2_t ctx, char cmd)
	NB IoT 2 send command function.

void	nbiot2_send_cmd_with_parameter (nbiot2_t ctx, char at_cmd_buf, char *param_buf)
	NB IoT 2 send command function with parameter.

void	nbiot2_send_cmd_check (nbiot2_t ctx, char at_cmd_buf)
	NB IoT 2 check the sent command.

void	nbiot2_send_cmd_parameter_check (nbiot2_t ctx, char at_cmd_buf)
	NB IoT 2 check the command parameters.

void	nbiot2_set_apn (nbiot2_t ctx, char apn)
	NB IoT 2 set sim card APN.

void	nbiot2_send_sms_text_mode (nbiot2_t ctx, char phone_number, char *message_context)
	NB IoT 2 send SMS in text mode.

err_t	nbiot2_send_sms_pdu (nbiot2_t ctx, char service_center_number, char phone_number, char sms_text)
	NB IoT 2 send SMS in PDU mode.

Detailed Description

API for configuring and manipulating NB IoT 2 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ nbiot2_cfg_setup()

void nbiot2_cfg_setup ( nbiot2_cfg_t * cfg )

NB IoT 2 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See nbiot2_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ nbiot2_generic_read()

err_t nbiot2_generic_read	(	nbiot2_t *	ctx,
		char *	data_out,
		uint16_t	len )

NB IoT 2 data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See nbiot2_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

>0 - Number of data bytes read,
<=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note: None.

◆ nbiot2_generic_write()

err_t nbiot2_generic_write	(	nbiot2_t *	ctx,
		char *	data_in,
		uint16_t	len )

NB IoT 2 data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See nbiot2_t object definition for detailed explanation.
[in]	data_in	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ nbiot2_hw_reset()

void nbiot2_hw_reset ( nbiot2_t * ctx )

NB IoT 2 hardware reset function.

This function is used to perform hardwarre reset.

Parameters

[in] ctx : Click context object. See #nbiot_t object definition for detailed explanation.

Returns: Nothing.

Note: None.

◆ nbiot2_init()

err_t nbiot2_init	(	nbiot2_t *	ctx,
		nbiot2_cfg_t *	cfg )

NB IoT 2 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See nbiot2_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See nbiot2_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ nbiot2_send_cmd()

void nbiot2_send_cmd	(	nbiot2_t *	ctx,
		char *	cmd )

NB IoT 2 send command function.

This function sends the specified command to the click module.

Parameters

[in]	ctx	: Click context object. See #nbiot_t object definition for detailed explanation.
[in]	cmd	: Command variable.

Returns: Nothing.

Note: None.

◆ nbiot2_send_cmd_check()

void nbiot2_send_cmd_check	(	nbiot2_t *	ctx,
		char *	at_cmd_buf )

NB IoT 2 check the sent command.

This function checks the command that is sent.

Parameters

[in]	ctx	: Click context object. See #nbiot_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ nbiot2_send_cmd_parameter_check()

void nbiot2_send_cmd_parameter_check	(	nbiot2_t *	ctx,
		char *	at_cmd_buf )

NB IoT 2 check the command parameters.

This function checks the command that is sent.

Parameters

[in]	ctx	: Click context object. See #nbiot_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.

Returns: Nothing.

Note: None.

◆ nbiot2_send_cmd_with_parameter()

void nbiot2_send_cmd_with_parameter	(	nbiot2_t *	ctx,
		char *	at_cmd_buf,
		char *	param_buf )

NB IoT 2 send command function with parameter.

This function sends commands to the click module.

Parameters

[in]	ctx	: Click context object. See #nbiot_t object definition for detailed explanation.
[in]	at_cmd_buf	: Command buffer.
[in]	param_buf	: Parameter buffer.

Returns: Nothing.

Note: None.

◆ nbiot2_send_sms_pdu()

err_t nbiot2_send_sms_pdu	(	nbiot2_t *	ctx,
		char *	service_center_number,
		char *	phone_number,
		char *	sms_text )

NB IoT 2 send SMS in PDU mode.

This function sends text message to a phone number in PDU mode.

Parameters

[in]	ctx	: Click context object. See ##nbiot_t object definition for detailed explanation.
[in]	service_center_number	: SMSC of the SIM card.
[in]	phone_number	: Phone number to message.
[in]	sms_text	Message to be sent.

Returns

>=0 - Success,
<0 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ nbiot2_send_sms_text_mode()

void nbiot2_send_sms_text_mode	(	nbiot2_t *	ctx,
		char *	phone_number,
		char *	message_context )

NB IoT 2 send SMS in text mode.

This function sends text message to a phone number.

Parameters

[in]	ctx	: Click context object. See ##nbiot_t object definition for detailed explanation.
[in]	phone_number	: Phone number to message.
[in]	sms_text	: Message to be sent.

Returns: Nothing.

Note: None.

◆ nbiot2_set_apn()

void nbiot2_set_apn	(	nbiot2_t *	ctx,
		char *	apn )

NB IoT 2 set sim card APN.

This function sets APN for sim card.

Parameters

[in]	ctx	: Click context object. See #nbiot_t object definition for detailed explanation.
[in]	sim_apn	: SIM card APN.

Returns: Nothing.

Note: None.

◆ nbiot2_set_rst_pin_state()

void nbiot2_set_rst_pin_state	(	nbiot2_t *	ctx,
		uint8_t	state )

NB IoT 2 sets state of the RST pin.

This function sets RST pin state.

Parameters

[in]	ctx	: Click context object. See #nbiot_t object definition for detailed explanation.
[in]	state	: Pin state ( 1 or 0 ).

Returns: Nothing.

Note: None.

◆ nbiot2_set_wup_pin_state()

void nbiot2_set_wup_pin_state	(	nbiot2_t *	ctx,
		uint8_t	state )

NB IoT 2 sets state of the WUP pin.

This function sets WUP pin state.

Parameters

[in]	ctx	: Click context object. See #nbiot_t object definition for detailed explanation.
[in]	state	: Pin state ( 1 or 0 ).

Returns: Nothing.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ nbiot2_cfg_setup()

◆ nbiot2_generic_read()

◆ nbiot2_generic_write()

◆ nbiot2_hw_reset()

◆ nbiot2_init()

◆ nbiot2_send_cmd()

◆ nbiot2_send_cmd_check()

◆ nbiot2_send_cmd_parameter_check()

◆ nbiot2_send_cmd_with_parameter()

◆ nbiot2_send_sms_pdu()

◆ nbiot2_send_sms_text_mode()

◆ nbiot2_set_apn()

◆ nbiot2_set_rst_pin_state()

◆ nbiot2_set_wup_pin_state()