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 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
69 #define NBIOT5_CMD_AT "AT"
70 #define NBIOT5_CMD_CFUN "AT+CFUN"
71 #define NBIOT5_CMD_CEREG "AT+CEREG"
72 #define NBIOT5_CMD_CGDCONT "AT+CGDCONT"
73 #define NBIOT5_CMD_CSQ "AT+CSQ"
74 #define NBIOT5_CMD_COPS "AT+COPS"
75 #define NBIOT5_CMD_CMGS "AT+CMGS"
76 #define NBIOT5_CMD_CMGF "AT+CMGF"
77 #define NBIOT5_CMD_ESOC "AT+ESOC"
78 #define NBIOT5_CMD_ESOCON "AT+ESOCON"
79 #define NBIOT5_CMD_ESOSEND "AT+ESOSEND"
80 #define NBIOT5_CMD_ESOCL "AT+ESOCL"
81 
86 #define NBIOT5_RSP_OK "OK"
87 #define NBIOT5_RSP_ERROR "ERROR"
88 
94 #define NBIOT5_RX_DRV_BUFFER_SIZE 256
95 #define NBIOT5_TX_DRV_BUFFER_SIZE 256
96  // nbiot5_set
98 
113 #define NBIOT5_MAP_MIKROBUS( cfg, mikrobus ) \
114  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
115  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
116  cfg.wup = MIKROBUS( mikrobus, MIKROBUS_AN ); \
117  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
118  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
119  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
120  // nbiot5_map // nbiot5
123 
128 typedef struct
129 {
130  // Output pins
131  digital_out_t rst;
132  digital_out_t cs;
133  digital_out_t wup;
134  digital_out_t en;
136  // Modules
137  uart_t uart;
139  // Buffers
140  uint8_t uart_rx_buffer[ NBIOT5_RX_DRV_BUFFER_SIZE ];
141  uint8_t uart_tx_buffer[ NBIOT5_TX_DRV_BUFFER_SIZE ];
143 } nbiot5_t;
144 
149 typedef struct
150 {
151  // Communication gpio pins
152  pin_name_t rx_pin;
153  pin_name_t tx_pin;
155  // Additional gpio pins
156  pin_name_t rst;
157  pin_name_t cs;
158  pin_name_t wup;
159  pin_name_t en;
161  // Static variable
162  uint32_t baud_rate;
164  uart_data_bits_t data_bit;
165  uart_parity_t parity_bit;
166  uart_stop_bits_t stop_bit;
168 } nbiot5_cfg_t;
169 
174 typedef enum
175 {
181 
183 
200 
214 err_t nbiot5_init ( nbiot5_t *ctx, nbiot5_cfg_t *cfg );
215 
228 err_t nbiot5_generic_write ( nbiot5_t *ctx, uint8_t *data_in, uint16_t len );
229 
242 err_t nbiot5_generic_read ( nbiot5_t *ctx, uint8_t *data_out, uint16_t len );
243 
253 void nbiot5_set_rst_pin ( nbiot5_t *ctx, uint8_t state );
254 
264 void nbiot5_set_cs_pin ( nbiot5_t *ctx, uint8_t state );
265 
275 void nbiot5_set_wup_pin ( nbiot5_t *ctx, uint8_t state );
276 
286 void nbiot5_set_en_pin ( nbiot5_t *ctx, uint8_t state );
287 
297 void nbiot5_send_cmd ( nbiot5_t *ctx, uint8_t *cmd );
298 
309 void nbiot5_send_cmd_with_par ( nbiot5_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
310 
320 void nbiot5_send_cmd_check ( nbiot5_t *ctx, uint8_t *at_cmd_buf );
321 
331 void nbiot5_send_cmd_par_check ( nbiot5_t *ctx, uint8_t *at_cmd_buf );
332 
342 void nbiot5_set_sim_apn ( nbiot5_t *ctx, uint8_t *sim_apn );
343 
354 void nbiot5_send_sms_text ( nbiot5_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
355 
369 err_t nbiot5_send_sms_pdu ( nbiot5_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
370 
371 #ifdef __cplusplus
372 }
373 #endif
374 #endif // NBIOT5_H
375  // nbiot5
377 
378 // ------------------------------------------------------------------------ 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:153
NBIOT5_ERROR_TIMEOUT
@ NBIOT5_ERROR_TIMEOUT
Definition: nbiot5.h:178
NBIOT5_ERROR_UNKNOWN
@ NBIOT5_ERROR_UNKNOWN
Definition: nbiot5.h:180
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:133
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:179
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:159
nbiot5_return_value_t
nbiot5_return_value_t
NB IoT 5 Click return value data.
Definition: nbiot5.h:175
NBIOT5_RX_DRV_BUFFER_SIZE
#define NBIOT5_RX_DRV_BUFFER_SIZE
NB IoT 5 driver buffer size.
Definition: nbiot5.h:94
nbiot5_cfg_t::wup
pin_name_t wup
Definition: nbiot5.h:158
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:162
nbiot5_cfg_t
NB IoT 5 Click configuration object.
Definition: nbiot5.h:150
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:129
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:166
nbiot5_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: nbiot5.h:165
NBIOT5_ERROR
@ NBIOT5_ERROR
Definition: nbiot5.h:177
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:157
nbiot5_cfg_t::rst
pin_name_t rst
Definition: nbiot5.h:156
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:176
nbiot5_cfg_t::rx_pin
pin_name_t rx_pin
Definition: nbiot5.h:152
nbiot5_t::rst
digital_out_t rst
Definition: nbiot5.h:131
nbiot5_t::cs
digital_out_t cs
Definition: nbiot5.h:132
NBIOT5_TX_DRV_BUFFER_SIZE
#define NBIOT5_TX_DRV_BUFFER_SIZE
Definition: nbiot5.h:95
nbiot5_cfg_t::uart_blocking
bool uart_blocking
Definition: nbiot5.h:163
nbiot5_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: nbiot5.h:164
nbiot5_t::en
digital_out_t en
Definition: nbiot5.h:134
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:137
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.