MIP_SDK  latest-2-g34f3e39
MicroStrain Communications Library for embedded systems
mip_descriptors.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <stddef.h>
4 #include <stdint.h>
5 #include <stdbool.h>
7 #include "mip_result.h"
8 
9 #ifdef __cplusplus
10 namespace mip {
11 namespace C {
13 extern "C" {
14 #endif // __cplusplus
15 
16 enum {
20 
25 
27 };
28 
29 bool mip_is_valid_descriptor_set(uint8_t descriptor_set);
30 bool mip_is_data_descriptor_set(uint8_t descriptor_set);
31 bool mip_is_cmd_descriptor_set(uint8_t descriptor_set);
32 bool mip_is_reserved_descriptor_set(uint8_t descriptor_set);
33 bool mip_is_gnss_data_descriptor_set(uint8_t descriptor_set);
34 
35 bool mip_is_valid_field_descriptor(uint8_t field_descriptor);
36 bool mip_is_cmd_field_descriptor(uint8_t field_descriptor);
37 bool mip_is_reply_field_descriptor(uint8_t field_descriptor);
38 bool mip_is_response_field_descriptor(uint8_t field_descriptor);
39 bool mip_is_reserved_cmd_field_descriptor(uint8_t field_descriptor);
40 bool mip_is_shared_data_field_descriptor(uint8_t field_descriptor);
41 
43 {
49 };
53 
54 
55 #ifdef __cplusplus
56 } // extern "C"
57 } // namespace C
58 } // namespace mip
59 #endif // __cplusplus
mip
A collection of C++ classes and functions covering the full mip api.
Definition: commands_3dm.c:11
mip::C::MIP_FUNCTION_READ
@ MIP_FUNCTION_READ
Definition: mip_descriptors.h:45
mip::C::mip_is_gnss_data_descriptor_set
bool mip_is_gnss_data_descriptor_set(uint8_t descriptor_set)
Determines if the descriptor set represents some kind of GNSS data.
Definition: mip_descriptors.c:70
mip::C::MIP_RESERVED_DESCRIPTOR_START
@ MIP_RESERVED_DESCRIPTOR_START
Definition: mip_descriptors.h:23
mip::C::mip_is_data_descriptor_set
bool mip_is_data_descriptor_set(uint8_t descriptor_set)
Determines if the descriptor set represents some kind of data.
Definition: mip_descriptors.c:34
mip::C::MIP_RESPONSE_DESCRIPTOR_START
@ MIP_RESPONSE_DESCRIPTOR_START
Definition: mip_descriptors.h:24
microstrain::C::microstrain_serializer
struct microstrain::C::microstrain_serializer microstrain_serializer
Structure used for serialization.
mip::C::MIP_REPLY_DESCRIPTOR
@ MIP_REPLY_DESCRIPTOR
Definition: mip_descriptors.h:22
mip_result.h
microstrain::C::microstrain_serializer
Structure used for serialization.
Definition: serialization.h:42
mip::C::MIP_FUNCTION_RESET
@ MIP_FUNCTION_RESET
Definition: mip_descriptors.h:48
mip::C::MIP_DATA_DESCRIPTOR_SET_START
@ MIP_DATA_DESCRIPTOR_SET_START
Definition: mip_descriptors.h:18
mip::C::mip_is_reserved_cmd_field_descriptor
bool mip_is_reserved_cmd_field_descriptor(uint8_t field_descriptor)
Determines if the field descriptor is reserved.
Definition: mip_descriptors.c:137
mip::C::insert_mip_function_selector
void insert_mip_function_selector(microstrain_serializer *serializer, enum mip_function_selector self)
mip::C::MIP_FUNCTION_LOAD
@ MIP_FUNCTION_LOAD
Definition: mip_descriptors.h:47
mip::C::mip_is_reply_field_descriptor
bool mip_is_reply_field_descriptor(uint8_t field_descriptor)
Determines if the field descriptor is for an ack/nack reply.
Definition: mip_descriptors.c:108
mip::C::MIP_INVALID_FIELD_DESCRIPTOR
@ MIP_INVALID_FIELD_DESCRIPTOR
Definition: mip_descriptors.h:21
mip::C::MIP_INVALID_DESCRIPTOR_SET
@ MIP_INVALID_DESCRIPTOR_SET
Definition: mip_descriptors.h:17
mip::C::MIP_RESERVED_DESCRIPTOR_SET_START
@ MIP_RESERVED_DESCRIPTOR_SET_START
Definition: mip_descriptors.h:19
mip::C::extract_mip_function_selector
void extract_mip_function_selector(microstrain_serializer *serializer, enum mip_function_selector *self)
mip::C::MIP_FUNCTION_SAVE
@ MIP_FUNCTION_SAVE
Definition: mip_descriptors.h:46
mip::C::MIP_FUNCTION_WRITE
@ MIP_FUNCTION_WRITE
Definition: mip_descriptors.h:44
mip::C::mip_is_reserved_descriptor_set
bool mip_is_reserved_descriptor_set(uint8_t descriptor_set)
Determines if the descriptor is reserved for special purposes.
Definition: mip_descriptors.c:58
mip::C::mip_is_valid_field_descriptor
bool mip_is_valid_field_descriptor(uint8_t field_descriptor)
Determines if the field descriptor is valid.
Definition: mip_descriptors.c:84
mip::C::MIP_SHARED_DATA_FIELD_DESCRIPTOR_START
@ MIP_SHARED_DATA_FIELD_DESCRIPTOR_START
Definition: mip_descriptors.h:26
mip::C::mip_is_valid_descriptor_set
bool mip_is_valid_descriptor_set(uint8_t descriptor_set)
Determines if the descriptor set is valid.
Definition: mip_descriptors.c:22
serialization.h
mip::C::mip_is_response_field_descriptor
bool mip_is_response_field_descriptor(uint8_t field_descriptor)
Determines if the field descriptor contains response data from a command.
Definition: mip_descriptors.c:123
mip::C::mip_is_shared_data_field_descriptor
bool mip_is_shared_data_field_descriptor(uint8_t field_descriptor)
Determines if the field descriptor is from the shared data set.
Definition: mip_descriptors.c:151
mip::C::mip_function_selector
mip_function_selector
Definition: mip_descriptors.h:42
mip::C::mip_is_cmd_descriptor_set
bool mip_is_cmd_descriptor_set(uint8_t descriptor_set)
Determines if the descriptor set contains commands.
Definition: mip_descriptors.c:46
mip::C::mip_is_cmd_field_descriptor
bool mip_is_cmd_field_descriptor(uint8_t field_descriptor)
Determines if the field descriptor is a command.
Definition: mip_descriptors.c:96