IRPyro messaging application
Communications program between IRPyro and IRPyro evaluation tool
message_interface_common.h
Go to the documentation of this file.
1 /**
2 ******************************************************************************
3 * @file message_interpreter.h
4 * @author _KEMET, Ltd
5 * @date March 2018
6 * @version Release 1.0.6
7 * @copyright (c) 2018 _KEMET, Ltd
8 * @brief GUI flag and data structure directed to the sensor
9 * @verbatim
10  ===============================================================================
11  ##### Description #####
12  ===============================================================================
13  [..]
14  Prototypes of the message interface functions
15  [..]
16  @endverbatim
17  ******************************************************************************
18  @attention <h2><center>&copy; COPYRIGHT 2018 _KEMET, Ltd</center></h2>
19  @verbatim
20  Copyright (c) 2018, _KEMET, Ltd
21  All rights reserved.
22 
23  THIS SOFTWARE IS PROVIDED BY _KEMET, Ltd ''AS IS'' AND ANY
24  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  DISCLAIMED. IN NO EVENT SHALL _KEMET, Ltd BE LIABLE FOR ANY
27  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  @endverbatim
34 
35  ******************************************************************************
36  */
37 /* Includes ------------------------------------------------------------------*/
38 #ifndef MESSAGE_INTERFACE_COMMON
39 #define MESSAGE_INTERFACE_COMMON
40 #include <stdint.h>
41 #include <string.h>
42 #endif
43 
44 #ifndef IRPyro_API_multi_device_layer
45 #include "IRPyro_API_multi_device_layer.h"
46 #endif
47 
48 #include "externals.h"
49 
50 uint8_t channel_processing(uint8_t *channel_count);
51 uint8_t channel_id_to_sensor(void);
52 uint8_t channel_id_to_channel(void);
53 void channel_id_next(void);
54 void process_parms_load(uint8_t *idx, uint8_t *num_sensors_to_process);
55 
56 /* ********** Copyright (c) 2018 _KEMET, Ltd. **********END OF FILE************/
channel_processing
uint8_t channel_processing(uint8_t *channel_count)
prepares for channel_id requests
Definition: message_interface_common.c:178
channel_id_to_channel
uint8_t channel_id_to_channel(void)
maps the GUI scope channel_id to physical channel on the sensor
Definition: message_interface_common.c:202
channel_id_to_sensor
uint8_t channel_id_to_sensor(void)
maps the GUI scope channel_id to physical sensor
Definition: message_interface_common.c:194
channel_id_next
void channel_id_next(void)
increments the channel index
Definition: message_interface_common.c:210
process_parms_load
void process_parms_load(uint8_t *idx, uint8_t *num_sensors_to_process)
configures for loop for single or multiple sensor operations
Definition: message_interface_common.c:139
externals.h
Interface variables: main, message_to_sensor and message_to_GUI.