nbiot4 2.0.0.0
NB IoT 4 Click Driver

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

Topics

 NB IoT 4 Device Settings
 Settings for registers of NB IoT 4 Click driver.
 
 NB IoT 4 MikroBUS Map
 MikroBUS pin mapping of NB IoT 4 Click driver.
 

Functions

void nbiot4_cfg_setup (nbiot4_cfg_t *cfg)
 NB IoT 4 configuration object setup function.
 
err_t nbiot4_init (nbiot4_t *ctx, nbiot4_cfg_t *cfg)
 NB IoT 4 initialization function.
 
err_t nbiot4_generic_write (nbiot4_t *ctx, uint8_t *data_in, uint16_t len)
 NB IoT 4 data writing function.
 
err_t nbiot4_generic_read (nbiot4_t *ctx, uint8_t *data_out, uint16_t len)
 NB IoT 4 data reading function.
 
void nbiot4_set_rst_pin (nbiot4_t *ctx, uint8_t state)
 NB IoT 4 set rst pin function.
 
void nbiot4_set_cs_pin (nbiot4_t *ctx, uint8_t state)
 NB IoT 4 set cs pin function.
 
uint8_t nbiot4_get_ring_pin (nbiot4_t *ctx)
 NB IoT 4 get ring pin function.
 
void nbiot4_send_cmd (nbiot4_t *ctx, uint8_t *cmd)
 Send command function.
 
void nbiot4_send_cmd_with_par (nbiot4_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 Send command function with parameter.
 
void nbiot4_send_cmd_check (nbiot4_t *ctx, uint8_t *at_cmd_buf)
 Check the sent command.
 
void nbiot4_send_cmd_par_check (nbiot4_t *ctx, uint8_t *at_cmd_buf)
 Check the command parameters.
 
void nbiot4_set_sim_apn (nbiot4_t *ctx, uint8_t *sim_apn)
 Set sim card APN.
 
void nbiot4_send_sms_text (nbiot4_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 NB IoT 4 send SMS in text mode.
 
err_t nbiot4_send_sms_pdu (nbiot4_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 NB IoT 4 send SMS in PDU mode.
 

Detailed Description

API for configuring and manipulating NB IoT 4 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

◆ nbiot4_cfg_setup()

void nbiot4_cfg_setup ( nbiot4_cfg_t * cfg)

NB IoT 4 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See nbiot4_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ nbiot4_generic_read()

err_t nbiot4_generic_read ( nbiot4_t * ctx,
uint8_t * data_out,
uint16_t len )

NB IoT 4 data reading function.

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

Parameters
[in]ctx: Click context object. See nbiot4_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.

◆ nbiot4_generic_write()

err_t nbiot4_generic_write ( nbiot4_t * ctx,
uint8_t * data_in,
uint16_t len )

NB IoT 4 data writing function.

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

Parameters
[in]ctx: Click context object. See nbiot4_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.

◆ nbiot4_get_ring_pin()

uint8_t nbiot4_get_ring_pin ( nbiot4_t * ctx)

NB IoT 4 get ring pin function.

This function returns the ring indication (RI) pin logic state.

Parameters
[in]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ nbiot4_init()

err_t nbiot4_init ( nbiot4_t * ctx,
nbiot4_cfg_t * cfg )

NB IoT 4 initialization function.

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

Parameters
[out]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See nbiot4_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ nbiot4_send_cmd()

void nbiot4_send_cmd ( nbiot4_t * ctx,
uint8_t * cmd )

Send command function.

This function sends a specified command to the click module.

Parameters
[in]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
[in]cmd: Command variable.
Returns
Nothing.
Note
None.

◆ nbiot4_send_cmd_check()

void nbiot4_send_cmd_check ( nbiot4_t * ctx,
uint8_t * at_cmd_buf )

Check the sent command.

This function checks the command that is sent.

Parameters
[in]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
[in]at_cmd_buf: Command buffer.
Returns
Nothing.
Note
None.

◆ nbiot4_send_cmd_par_check()

void nbiot4_send_cmd_par_check ( nbiot4_t * ctx,
uint8_t * at_cmd_buf )

Check the command parameters.

This function checks the command that is sent.

Parameters
[in]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
[in]at_cmd_buf: Command buffer.
Returns
Nothing.
Note
None.

◆ nbiot4_send_cmd_with_par()

void nbiot4_send_cmd_with_par ( nbiot4_t * ctx,
uint8_t * at_cmd_buf,
uint8_t * param_buf )

Send command function with parameter.

This function sends a command with specified parameter to the click module.

Parameters
[in]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
[in]at_cmd_buf: Command buffer.
[in]param_buf: Parameter buffer.
Returns
Nothing.
Note
None.

◆ nbiot4_send_sms_pdu()

err_t nbiot4_send_sms_pdu ( nbiot4_t * ctx,
uint8_t * service_center_number,
uint8_t * phone_number,
uint8_t * sms_text )

NB IoT 4 send SMS in PDU mode.

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

Parameters
[in]ctx: Click context object. See nbiot4_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.

◆ nbiot4_send_sms_text()

void nbiot4_send_sms_text ( nbiot4_t * ctx,
uint8_t * phone_number,
uint8_t * sms_text )

NB IoT 4 send SMS in text mode.

This function sends text message to a phone number.

Parameters
[in]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
[in]phone_number: Phone number to message.
[in]sms_text: Message to be sent.
Returns
Nothing.
Note
None.

◆ nbiot4_set_cs_pin()

void nbiot4_set_cs_pin ( nbiot4_t * ctx,
uint8_t state )

NB IoT 4 set cs pin function.

This function sets the SPI chip select (CS) pin logic state.

Parameters
[in]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.

◆ nbiot4_set_rst_pin()

void nbiot4_set_rst_pin ( nbiot4_t * ctx,
uint8_t state )

NB IoT 4 set rst pin function.

This function sets the RESET pin logic state.

Parameters
[in]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.

◆ nbiot4_set_sim_apn()

void nbiot4_set_sim_apn ( nbiot4_t * ctx,
uint8_t * sim_apn )

Set sim card APN.

This function sets APN for sim card.

Parameters
[in]ctx: Click context object. See nbiot4_t object definition for detailed explanation.
[in]sim_apn: SIM card APN.
Returns
Nothing.
Note
None.