spectral3  2.0.0.0
spectral3.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 SPECTRAL3_H
36 #define SPECTRAL3_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_uart.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define SPECTRAL3_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
68  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
69  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define SPECTRAL3_RETVAL uint8_t
78 
79 #define SPECTRAL3_OK 0x00
80 #define SPECTRAL3_INIT_ERROR 0xFF
81 
87 #define DRV_RX_BUFFER_SIZE 200
88 #define DRV_TX_BUFFER_SIZE 100
89  // End group macro
92 // --------------------------------------------------------------- PUBLIC TYPES
100 typedef struct
101 {
102  // Output pins
103 
104  digital_out_t rst;
105 
106  // Input pins
107 
108  digital_in_t int_pin;
109 
110  // Modules
111 
112  uart_t uart;
113 
114  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
115  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
116 
117 } spectral3_t;
118 
122 typedef struct
123 {
124  // Communication gpio pins
125 
126  pin_name_t rx_pin;
127  pin_name_t tx_pin;
128 
129  // Additional gpio pins
130 
131  pin_name_t rst;
132  pin_name_t int_pin;
133 
134  // static variable
135 
136  uint32_t baud_rate; // Clock speed.
138  uart_data_bits_t data_bit; // Data bits.
139  uart_parity_t parity_bit; // Parity bit.
140  uart_stop_bits_t stop_bit; // Stop bits.
141 
143 
147 typedef uint8_t spectral3_error_t;
148  // End types group
150 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
151 
157 #ifdef __cplusplus
158 extern "C"{
159 #endif
160 
170 
180 
187 
194 void spectral3_set_rst_pin ( spectral3_t *ctx, uint8_t state );
195 
203 void spectral3_generic_write ( spectral3_t *ctx, char *data_buf, uint16_t len );
204 
214 int32_t spectral3_generic_read ( spectral3_t *ctx, char *data_buf, uint16_t max_len );
215 
222 void spectral3_send_command ( spectral3_t *ctx, char *command );
223 
230 void spectral3_get_data ( char *rsp, uint16_t *c_data );
231 
232 #ifdef __cplusplus
233 }
234 #endif
235 #endif // _SPECTRAL3_H_
236  // End public_function group
239 
240 // ------------------------------------------------------------------------- END
spectral3_set_rst_pin
void spectral3_set_rst_pin(spectral3_t *ctx, uint8_t state)
Set RST ( reset ) pin state.
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: spectral3.h:87
spectral3_generic_read
int32_t spectral3_generic_read(spectral3_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
spectral3_get_data
void spectral3_get_data(char *rsp, uint16_t *c_data)
Read raw X, Y, Z and NIR data as well as two special internal registers D, & C.
spectral3_cfg_t::rst
pin_name_t rst
Definition: spectral3.h:131
spectral3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: spectral3.h:127
spectral3_cfg_setup
void spectral3_cfg_setup(spectral3_cfg_t *cfg)
Config Object Initialization function.
spectral3_t
Click ctx object definition.
Definition: spectral3.h:101
spectral3_cfg_t::uart_blocking
bool uart_blocking
Definition: spectral3.h:137
spectral3_cfg_t::baud_rate
uint32_t baud_rate
Definition: spectral3.h:136
spectral3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: spectral3.h:138
SPECTRAL3_RETVAL
#define SPECTRAL3_RETVAL
Definition: spectral3.h:77
spectral3_t::uart
uart_t uart
Definition: spectral3.h:112
spectral3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: spectral3.h:140
spectral3_module_reset
void spectral3_module_reset(spectral3_t *ctx)
Reset module.
spectral3_error_t
uint8_t spectral3_error_t
Error type.
Definition: spectral3.h:147
spectral3_t::int_pin
digital_in_t int_pin
Definition: spectral3.h:108
spectral3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: spectral3.h:139
spectral3_cfg_t
Click configuration structure definition.
Definition: spectral3.h:123
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: spectral3.h:88
spectral3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: spectral3.h:126
spectral3_send_command
void spectral3_send_command(spectral3_t *ctx, char *command)
Send command.
spectral3_init
SPECTRAL3_RETVAL spectral3_init(spectral3_t *ctx, spectral3_cfg_t *cfg)
Initialization function.
spectral3_cfg_t::int_pin
pin_name_t int_pin
Definition: spectral3.h:132
spectral3_generic_write
void spectral3_generic_write(spectral3_t *ctx, char *data_buf, uint16_t len)
Generic write function.
spectral3_t::rst
digital_out_t rst
Definition: spectral3.h:104