thingstream  2.0.0.0
thingstream.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef THINGSTREAM_H
36 #define THINGSTREAM_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define THINGSTREAM_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
54  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
55  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
56 
62 #define THINGSTREAM_RETVAL uint8_t
63 
64 #define THINGSTREAM_OK 0x00
65 #define THINGSTREAM_INIT_ERROR 0xFF
66 
72 #define DRV_RX_BUFFER_SIZE 600
73 #define DRV_TX_BUFFER_SIZE 100
74 
76 #define THINGSTREAM_PIN_STATE_HIGH 1
77 #define THINGSTREAM_PIN_STATE_LOW 0
78 
79 #define THINGSTREAM_SUCCESS 0xAA
80 #define THINGSTREAM_ERROR 0xBB
81 
86 #define THINGSTREAM_NEMA_CGNSINF 1
87 #define THINGSTREAM_NEMA_GPGLL 3
88 #define THINGSTREAM_NEMA_CGNSINF_NUM_ELEMENT 20
89 #define THINGSTREAM_NEMA_GPGLL_NUM_ELEMENT 5
90 
96 #define THINGSTREAM_GPGGA_TIME 1
97 #define THINGSTREAM_GPGGA_LATITUDE 2
98 #define THINGSTREAM_GPGGA_LATITUDE_SIDE 3
99 #define THINGSTREAM_GPGGA_LONGITUDE 4
100 #define THINGSTREAM_GPGGA_LONGITUDE_SIDE 5
101 #define THINGSTREAM_GPGGA_QUALITY_INDICATOR 6
102 #define THINGSTREAM_GPGGA_NUMBER_OF_SATELLITES 7
103 #define THINGSTREAM_GPGGA_H_DILUTION_OF_POS 8
104 #define THINGSTREAM_GPGGA_ALTITUDE 9
105 #define THINGSTREAM_GPGGA_ALTITUDE_UNIT 10
106 #define THINGSTREAM_GPGGA_GEOIDAL_SEPARATION 11
107 #define THINGSTREAM_GPGGA_GEOIDAL_SEPARATION_UNIT 12
108 #define THINGSTREAM_GPGGA_TIME_SINCE_LAST_DGPS 13
109 #define THINGSTREAM_GPGGA_DGPS_REFERENCE_STATION_ID 14
110 
116 #define THINGSTREAM_GPGLL_LATITUDE 1
117 #define THINGSTREAM_GPGLL_LATITUDE_SIDE 2
118 #define THINGSTREAM_GPGLL_LONGITUDE 3
119 #define THINGSTREAM_GPGLL_LONGITUDE_SIDE 4
120 
126 #define THINGSTREAM_ERROR_COMMAND_OR_ELEMENT 0xFF
127 #define THINGSTREAM_ERROR_START_OR_END_COMMAND 0x8F
128 #define THINGSTREAM_ERROR_NEXT_ELEMENT 0x4F
129 #define THINGSTREAM_ERROR_CURRENT_ELEMENT 0x2F
130 #define THINGSTREAM_NO_ERROR 0x00
131 
137 #define THINGSTREAM_CGNSINF_RUN_STAT 1
138 #define THINGSTREAM_CGNSINF_FIX_STAT 2
139 #define THINGSTREAM_CGNSINF_DATE_TIME 3
140 #define THINGSTREAM_CGNSINF_LATITUDE 4
141 #define THINGSTREAM_CGNSINF_LONGITUDE 5
142 #define THINGSTREAM_CGNSINF_ALTITUDE 6
143 #define THINGSTREAM_CGNSINF_SPEED 7
144 #define THINGSTREAM_CGNSINF_COURSE 8
145 #define THINGSTREAM_CGNSINF_FIX_MODE 9
146 #define THINGSTREAM_CGNSINF_RESERVED1 10
147 #define THINGSTREAM_CGNSINF_HDOP 11
148 #define THINGSTREAM_CGNSINF_PDOP 12
149 #define THINGSTREAM_CGNSINF_VDOP 13
150 #define THINGSTREAM_CGNSINF_RESERVED2 14
151 #define THINGSTREAM_CGNSINF_SAT_VIEW 15
152 #define THINGSTREAM_CGNSINF_SAT_USED 16
153 #define THINGSTREAM_CGNSINF_GLONASS_VIEW 17
154 #define THINGSTREAM_CGNSINF_RESERVED3 18
155 #define THINGSTREAM_CGNSINF_C_N0 19
156 #define THINGSTREAM_CGNSINF_HPA 20
157 #define THINGSTREAM_CGNSINF_VPA 21
158  // End group macro
161 // --------------------------------------------------------------- PUBLIC TYPES
169 typedef struct
170 {
171  // Output pins
172 
173  digital_out_t rst;
174 
175  // Modules
176 
177  uart_t uart;
178 
179  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
180  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
181 
182 } thingstream_t;
183 
187 typedef struct
188 {
189  // Communication gpio pins
190 
191  pin_name_t rx_pin;
192  pin_name_t tx_pin;
193 
194  // Additional gpio pins
195 
196  pin_name_t rst;
197 
198  // static variable
199 
200  uint32_t baud_rate; // Clock speed.
202  uart_data_bits_t data_bit; // Data bits.
203  uart_parity_t parity_bit; // Parity bit.
204  uart_stop_bits_t stop_bit; // Stop bits.
205 
207 
211 // Actuator switch type
213 
214 // Actuator counter type
216 
217 // Actuator string type
219 
220 // Parser error type
221 typedef uint8_t thingstream_error_t;
222  // End types group
224 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
225 
231 #ifdef __cplusplus
232 extern "C"{
233 #endif
234 
244 
253 
260 void thingstream_module_power ( thingstream_t *ctx, uint8_t power_state );
261 
268 uint8_t thingstream_reset_pin_state ( thingstream_t *ctx, uint8_t state );
269 
277 void thingstream_generic_write ( thingstream_t *ctx, char *data_buf, uint16_t len );
278 
288 int32_t thingstream_generic_read ( thingstream_t *ctx, char *data_buf, uint16_t max_len );
289 
296 void thingstream_send_command ( thingstream_t *ctx, char *command );
297 
309 (
310  char *rsp, uint8_t command,
311  uint8_t element, char *parser_buf
312 );
313 
314 #ifdef __cplusplus
315 }
316 #endif
317 #endif // _THINGSTREAM_H_
318  // End public_function group
321 
322 // ------------------------------------------------------------------------- END
thingstream_send_command
void thingstream_send_command(thingstream_t *ctx, char *command)
Send command.
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: thingstream.h:72
THINGSTREAM_RETVAL
#define THINGSTREAM_RETVAL
Definition: thingstream.h:62
thingstream_cfg_t::baud_rate
uint32_t baud_rate
Definition: thingstream.h:200
thingstream_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: thingstream.h:204
thingstream_init
THINGSTREAM_RETVAL thingstream_init(thingstream_t *ctx, thingstream_cfg_t *cfg)
Initialization function.
thingstream_actuator_sw_t
uint8_t thingstream_actuator_sw_t
Error type.
Definition: thingstream.h:212
thingstream_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: thingstream.h:202
thingstream_reset_pin_state
uint8_t thingstream_reset_pin_state(thingstream_t *ctx, uint8_t state)
Set RST pin state.
thingstream_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: thingstream.h:203
thingstream_cfg_setup
void thingstream_cfg_setup(thingstream_cfg_t *cfg)
Config Object Initialization function.
thingstream_cfg_t::rst
pin_name_t rst
Definition: thingstream.h:196
thingstream_module_power
void thingstream_module_power(thingstream_t *ctx, uint8_t power_state)
Power module.
thingstream_generic_parser
thingstream_error_t thingstream_generic_parser(char *rsp, uint8_t command, uint8_t element, char *parser_buf)
Generic parser function.
thingstream_error_t
uint8_t thingstream_error_t
Definition: thingstream.h:221
thingstream_cfg_t::tx_pin
pin_name_t tx_pin
Definition: thingstream.h:192
thingstream_t::rst
digital_out_t rst
Definition: thingstream.h:173
thingstream_actuator_cnt_t
int16_t thingstream_actuator_cnt_t
Definition: thingstream.h:215
thingstream_cfg_t
Click configuration structure definition.
Definition: thingstream.h:187
thingstream_t
Click ctx object definition.
Definition: thingstream.h:169
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: thingstream.h:73
thingstream_cfg_t::rx_pin
pin_name_t rx_pin
Definition: thingstream.h:191
thingstream_generic_read
int32_t thingstream_generic_read(thingstream_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
thingstream_actuator_str_t
char thingstream_actuator_str_t
Definition: thingstream.h:218
thingstream_generic_write
void thingstream_generic_write(thingstream_t *ctx, char *data_buf, uint16_t len)
Generic write function.
thingstream_t::uart
uart_t uart
Definition: thingstream.h:177
thingstream_cfg_t::uart_blocking
bool uart_blocking
Definition: thingstream.h:201