nbiot5  2.0.0.0
nbiot5.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef NBIOT5_H
29 #define NBIOT5_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
73 #define NBIOT5_CMD_AT "AT"
74 #define NBIOT5_CMD_CFUN "AT+CFUN"
75 #define NBIOT5_CMD_CEREG "AT+CEREG"
76 #define NBIOT5_CMD_CGDCONT "AT+CGDCONT"
77 #define NBIOT5_CMD_CSQ "AT+CSQ"
78 #define NBIOT5_CMD_COPS "AT+COPS"
79 #define NBIOT5_CMD_CMGS "AT+CMGS"
80 #define NBIOT5_CMD_CMGF "AT+CMGF"
81 #define NBIOT5_CMD_ESOC "AT+ESOC"
82 #define NBIOT5_CMD_ESOCON "AT+ESOCON"
83 #define NBIOT5_CMD_ESOSEND "AT+ESOSEND"
84 #define NBIOT5_CMD_ESOCL "AT+ESOCL"
85 
90 #define NBIOT5_RSP_OK "OK"
91 #define NBIOT5_RSP_ERROR "ERROR"
92 
98 #define NBIOT5_RX_DRV_BUFFER_SIZE 256
99 #define NBIOT5_TX_DRV_BUFFER_SIZE 256
100  // nbiot5_set
102 
117 #define NBIOT5_MAP_MIKROBUS( cfg, mikrobus ) \
118  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
119  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
120  cfg.wup = MIKROBUS( mikrobus, MIKROBUS_AN ); \
121  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
122  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
123  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
124  // nbiot5_map // nbiot5
127 
132 typedef struct
133 {
134  // Output pins
135  digital_out_t rst;
136  digital_out_t cs;
137  digital_out_t wup;
138  digital_out_t en;
140  // Modules
141  uart_t uart;
143  // Buffers
144  uint8_t uart_rx_buffer[ NBIOT5_RX_DRV_BUFFER_SIZE ];
145  uint8_t uart_tx_buffer[ NBIOT5_TX_DRV_BUFFER_SIZE ];
147 } nbiot5_t;
148 
153 typedef struct
154 {
155  // Communication gpio pins
156  pin_name_t rx_pin;
157  pin_name_t tx_pin;
159  // Additional gpio pins
160  pin_name_t rst;
161  pin_name_t cs;
162  pin_name_t wup;
163  pin_name_t en;
165  // Static variable
166  uint32_t baud_rate;
168  uart_data_bits_t data_bit;
169  uart_parity_t parity_bit;
170  uart_stop_bits_t stop_bit;
172 } nbiot5_cfg_t;
173 
178 typedef enum
179 {
185 
187 
204 
218 err_t nbiot5_init ( nbiot5_t *ctx, nbiot5_cfg_t *cfg );
219 
232 err_t nbiot5_generic_write ( nbiot5_t *ctx, uint8_t *data_in, uint16_t len );
233 
246 err_t nbiot5_generic_read ( nbiot5_t *ctx, uint8_t *data_out, uint16_t len );
247 
257 void nbiot5_set_rst_pin ( nbiot5_t *ctx, uint8_t state );
258 
268 void nbiot5_set_cs_pin ( nbiot5_t *ctx, uint8_t state );
269 
279 void nbiot5_set_wup_pin ( nbiot5_t *ctx, uint8_t state );
280 
290 void nbiot5_set_en_pin ( nbiot5_t *ctx, uint8_t state );
291 
301 void nbiot5_send_cmd ( nbiot5_t *ctx, uint8_t *cmd );
302 
313 void nbiot5_send_cmd_with_par ( nbiot5_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
314 
324 void nbiot5_send_cmd_check ( nbiot5_t *ctx, uint8_t *at_cmd_buf );
325 
335 void nbiot5_send_cmd_par_check ( nbiot5_t *ctx, uint8_t *at_cmd_buf );
336 
346 void nbiot5_set_sim_apn ( nbiot5_t *ctx, uint8_t *sim_apn );
347 
358 void nbiot5_send_sms_text ( nbiot5_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
359 
373 err_t nbiot5_send_sms_pdu ( nbiot5_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
374 
375 #ifdef __cplusplus
376 }
377 #endif
378 #endif // NBIOT5_H
379  // nbiot5
381 
382 // ------------------------------------------------------------------------ END
nbiot5_set_cs_pin
void nbiot5_set_cs_pin(nbiot5_t *ctx, uint8_t state)
NB IoT 5 set cs pin function.
nbiot5_cfg_t::tx_pin
pin_name_t tx_pin
Definition: nbiot5.h:157
NBIOT5_ERROR_TIMEOUT
@ NBIOT5_ERROR_TIMEOUT
Definition: nbiot5.h:182
NBIOT5_ERROR_UNKNOWN
@ NBIOT5_ERROR_UNKNOWN
Definition: nbiot5.h:184
nbiot5_generic_write
err_t nbiot5_generic_write(nbiot5_t *ctx, uint8_t *data_in, uint16_t len)
NB IoT 5 data writing function.
nbiot5_set_en_pin
void nbiot5_set_en_pin(nbiot5_t *ctx, uint8_t state)
NB IoT 5 set en pin function.
nbiot5_t::wup
digital_out_t wup
Definition: nbiot5.h:137
nbiot5_init
err_t nbiot5_init(nbiot5_t *ctx, nbiot5_cfg_t *cfg)
NB IoT 5 initialization function.
NBIOT5_ERROR_CMD
@ NBIOT5_ERROR_CMD
Definition: nbiot5.h:183
nbiot5_set_rst_pin
void nbiot5_set_rst_pin(nbiot5_t *ctx, uint8_t state)
NB IoT 5 set rst pin function.
nbiot5_cfg_t::en
pin_name_t en
Definition: nbiot5.h:163
nbiot5_return_value_t
nbiot5_return_value_t
NB IoT 5 Click return value data.
Definition: nbiot5.h:179
NBIOT5_RX_DRV_BUFFER_SIZE
#define NBIOT5_RX_DRV_BUFFER_SIZE
NB IoT 5 driver buffer size.
Definition: nbiot5.h:98
nbiot5_cfg_t::wup
pin_name_t wup
Definition: nbiot5.h:162
nbiot5_set_wup_pin
void nbiot5_set_wup_pin(nbiot5_t *ctx, uint8_t state)
NB IoT 5 set wup pin function.
nbiot5_send_cmd_with_par
void nbiot5_send_cmd_with_par(nbiot5_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
nbiot5_cfg_t::baud_rate
uint32_t baud_rate
Definition: nbiot5.h:166
nbiot5_cfg_t
NB IoT 5 Click configuration object.
Definition: nbiot5.h:154
nbiot5_send_cmd
void nbiot5_send_cmd(nbiot5_t *ctx, uint8_t *cmd)
Send command function.
nbiot5_t
NB IoT 5 Click context object.
Definition: nbiot5.h:133
nbiot5_cfg_setup
void nbiot5_cfg_setup(nbiot5_cfg_t *cfg)
NB IoT 5 configuration object setup function.
nbiot5_send_sms_text
void nbiot5_send_sms_text(nbiot5_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
NB IoT 5 send SMS in text mode.
nbiot5_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: nbiot5.h:170
nbiot5_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: nbiot5.h:169
NBIOT5_ERROR
@ NBIOT5_ERROR
Definition: nbiot5.h:181
nbiot5_set_sim_apn
void nbiot5_set_sim_apn(nbiot5_t *ctx, uint8_t *sim_apn)
Set sim card APN.
nbiot5_cfg_t::cs
pin_name_t cs
Definition: nbiot5.h:161
nbiot5_cfg_t::rst
pin_name_t rst
Definition: nbiot5.h:160
nbiot5_send_sms_pdu
err_t nbiot5_send_sms_pdu(nbiot5_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
NB IoT 5 send SMS in PDU mode.
NBIOT5_OK
@ NBIOT5_OK
Definition: nbiot5.h:180
nbiot5_cfg_t::rx_pin
pin_name_t rx_pin
Definition: nbiot5.h:156
nbiot5_t::rst
digital_out_t rst
Definition: nbiot5.h:135
nbiot5_t::cs
digital_out_t cs
Definition: nbiot5.h:136
NBIOT5_TX_DRV_BUFFER_SIZE
#define NBIOT5_TX_DRV_BUFFER_SIZE
Definition: nbiot5.h:99
nbiot5_cfg_t::uart_blocking
bool uart_blocking
Definition: nbiot5.h:167
nbiot5_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: nbiot5.h:168
nbiot5_t::en
digital_out_t en
Definition: nbiot5.h:138
nbiot5_generic_read
err_t nbiot5_generic_read(nbiot5_t *ctx, uint8_t *data_out, uint16_t len)
NB IoT 5 data reading function.
nbiot5_t::uart
uart_t uart
Definition: nbiot5.h:141
nbiot5_send_cmd_par_check
void nbiot5_send_cmd_par_check(nbiot5_t *ctx, uint8_t *at_cmd_buf)
Check the command parameters.
nbiot5_send_cmd_check
void nbiot5_send_cmd_check(nbiot5_t *ctx, uint8_t *at_cmd_buf)
Check the sent command.