aboutsummaryrefslogtreecommitdiffstats
path: root/libs/bitfield-c/src/canutil/read.h
blob: 8afe4f4aa3f8686a2f9331d36fd7e9ee257e4c53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
#ifndef __READ_H__
#define __READ_H__

#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Public: Parse a CAN signal from a message and apply required transformation.
 *
 * source - the payload containing the signal.
 * bit_offset - the starting bit for the signal.
 * bit_size - the width of the signal.
 * factor - the transformation factor for the signal value, applied after
 *      pulling out the bit field. Use 1.0 for no factor.
 * offset - the transformation offset for the signal value, applied after
 *      pulling out the bit field. Use 0 for no offset.
 *
 * Returns the decoded and transformed value of the signal.
 */
float eightbyte_parse_float(const uint64_t source, const unsigned int bit_offset,
        const unsigned int bit_size, const float factor, const float offset);

/* Public: Parse a CAN signal from a message storage as a byte array and apply
 * required transformation.
 *
 * source - the payload containing the signal.
 * source_size - the size of the payload in bytes.
 * bit_offset - the starting bit for the signal.
 * bit_size - the width of the signal.
 * factor - the transformation factor for the signal value, applied after
 *      pulling out the bit field. Use 1.0 for no factor.
 * offset - the transformation offset for the signal value, applied after
 *      pulling out the bit field. Use 0 for no offset.
 *
 * Returns the decoded and transformed value of the signal.
 */
float bitfield_parse_float(const uint8_t source[], const unsigned int source_size,
        const unsigned int bit_offset, const unsigned int bit_size, const float factor,
        const float offset);

/* Public: Parse a CAN signal from a message and interpret it as a boolean.
 *
 * source - the payload containing the signal.
 * bit_offset - the starting bit for the signal.
 * bit_size - the width of the signal.
 * factor - the transformation factor for the signal value, applied after
 *      pulling out the bit field. Use 1.0 for no factor.
 * offset - the transformation offset for the signal value, applied after
 *      pulling out the bit field. Use 0 for no offset.
 *
 * Returns false if the value was 0, otherwise true.
 */
bool eightbyte_parse_bool(uint64_t source, unsigned int bit_offset, unsigned int bit_size,
        float factor, float offset);

/* Public: Parse a CAN signal from a message storage as a byte array and
 * interpret it as a boolean.
 *
 * source - the payload containing the signal.
 * source_size - the size of the payload in bytes.
 * bit_offset - the starting bit for the signal.
 * bit_size - the width of the signal.
 * factor - the transformation factor for the signal value, applied after
 *      pulling out the bit field. Use 1.0 for no factor.
 * offset - the transformation offset for the signal value, applied after
 *      pulling out the bit field. Use 0 for no offset.
 *
 * Returns false if the value was 0, otherwise true.
 */
bool bitfield_parse_bool(const uint8_t source[], const unsigned int source_size,
        const unsigned int bit_offset, const unsigned int bit_size, const float factor,
        const float offset);

#ifdef __cplusplus
}
#endif

#endif // __READ_H__