IRPyro messaging application
Communications program between IRPyro and IRPyro evaluation tool
message_unpack.h
Go to the documentation of this file.
1
/**
2
******************************************************************************
3
* @file message_unpack.h
4
* @author _KEMET, Ltd
5
* @date March 2018
6
* @version Release 1.0.6
7
* @copyright (c) 2018 _KEMET, Ltd
8
* @brief Decodes a byte stream from the GUI into a data structure applicable to the sensor
9
******************************************************************************
10
@attention <h2><center>© COPYRIGHT 2018 _KEMET, Ltd</center></h2>
11
@verbatim
12
Copyright (c) 2018, _KEMET, Ltd
13
All rights reserved.
14
15
THIS SOFTWARE IS PROVIDED BY _KEMET, Ltd ''AS IS'' AND ANY
16
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18
DISCLAIMED. IN NO EVENT SHALL _KEMET, Ltd BE LIABLE FOR ANY
19
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25
@endverbatim
26
******************************************************************************
27
*/
28
/* Includes ------------------------------------------------------------------*/
29
#ifndef MESSAGE_UNPACK
30
#define MESSAGE_UNPACK
31
#include <stdint.h>
32
#include <string.h>
33
#include "
queue_handle.h
"
34
#endif
35
36
#define CMD_LIST_SIZE (35)
37
typedef
enum
38
{
39
decode_fail
,
40
decode_success
,
41
no_data
42
}
decode_result_type
;
43
44
decode_result_type
message_unpack_decode
(
void
);
45
void
message_unpack_result
(uint8_t *cmd_code_result, uint8_t *
sensor_destination
, uint8_t *
cmd_payload
);
46
47
/* ********** Copyright (c) 2018 _KEMET, Ltd. **********END OF FILE************/
48
message_unpack_result
void message_unpack_result(uint8_t *cmd_code_result, uint8_t *sensor_destination, uint8_t *cmd_payload)
gives access to the command code and the corresponding payload (if any)
Definition:
message_unpack.c:336
message_unpack_decode
decode_result_type message_unpack_decode(void)
FSM to decode a received command If the command is valid, the command code and the payload (if any) a...
Definition:
message_unpack.c:365
sensor_destination
uint8_t sensor_destination
Definition:
main.c:297
decode_fail
@ decode_fail
Definition:
message_unpack.h:39
queue_handle.h
Manages message queues from the GUI to sensor and sensor to GUI.
command_table::cmd_payload
uint8_t cmd_payload
Definition:
message_unpack.c:86
no_data
@ no_data
Definition:
message_unpack.h:41
decode_result_type
decode_result_type
Definition:
message_unpack.h:38
decode_success
@ decode_success
Definition:
message_unpack.h:40
source
IRPyro_API_messaging_application
inc
message_unpack.h
Generated on Thu Jul 2 2020 16:22:16 for IRPyro messaging application by
1.8.18