MIP_SDK  v3.0.0
MicroStrain Communications Library for embedded systems
commands_gnss.h
Go to the documentation of this file.
1 #pragma once
2 
4 #include <mip/mip_descriptors.h>
5 #include <mip/mip_result.h>
6 #include <mip/mip_interface.h>
7 
8 #include <stdint.h>
9 #include <stddef.h>
10 #include <stdbool.h>
11 
12 #ifdef __cplusplus
13 namespace mip {
14 namespace C {
15 extern "C" {
16 
17 #endif // __cplusplus
18 
25 
27 // Descriptors
29 
30 enum
31 {
33 
37 
41 };
42 
44 // Shared Type Definitions
46 
47 enum { MIP_GNSS_GPS_ENABLE_L1CA = 0x0001 };
48 enum { MIP_GNSS_GPS_ENABLE_L2C = 0x0002 };
49 enum { MIP_GNSS_GPS_ENABLE_L5 = 0x0004 };
50 enum { MIP_GNSS_GLONASS_ENABLE_L1OF = 0x0001 };
51 enum { MIP_GNSS_GLONASS_ENABLE_L2OF = 0x0002 };
52 enum { MIP_GNSS_GALILEO_ENABLE_E1 = 0x0001 };
53 enum { MIP_GNSS_GALILEO_ENABLE_E5B = 0x0002 };
54 enum { MIP_GNSS_GALILEO_ENABLE_E5A = 0x0004 };
55 enum { MIP_GNSS_BEIDOU_ENABLE_B1 = 0x0001 };
56 enum { MIP_GNSS_BEIDOU_ENABLE_B2 = 0x0002 };
57 enum { MIP_GNSS_BEIDOU_ENABLE_B2A = 0x0004 };
58 
60 // Mip Fields
62 
69 
71 {
72  uint8_t receiver_id;
74  char description[32];
75 };
77 
80 
81 
83 
85 {
86  uint8_t num_receivers;
88 };
90 
93 
94 mip_cmd_result mip_gnss_receiver_info(mip_interface* device, uint8_t* num_receivers_out, uint8_t num_receivers_out_max, mip_gnss_receiver_info_command_info* receiver_info_out);
95 
104 
106 {
108  uint8_t gps_enable;
109  uint8_t glonass_enable;
110  uint8_t galileo_enable;
111  uint8_t beidou_enable;
112  uint8_t reserved[4];
113 };
115 
118 
120 {
121  uint8_t gps_enable;
122  uint8_t glonass_enable;
123  uint8_t galileo_enable;
124  uint8_t beidou_enable;
125  uint8_t reserved[4];
126 };
128 
131 
132 mip_cmd_result mip_gnss_write_signal_configuration(mip_interface* device, uint8_t gps_enable, uint8_t glonass_enable, uint8_t galileo_enable, uint8_t beidou_enable, const uint8_t* reserved);
133 mip_cmd_result mip_gnss_read_signal_configuration(mip_interface* device, uint8_t* gps_enable_out, uint8_t* glonass_enable_out, uint8_t* galileo_enable_out, uint8_t* beidou_enable_out, uint8_t* reserved_out);
137 
146 
148 {
150  uint8_t enable;
151  uint8_t reserved[3];
152 };
154 
157 
159 {
160  uint8_t enable;
161  uint8_t reserved[3];
162 };
164 
167 
168 mip_cmd_result mip_gnss_write_rtk_dongle_configuration(mip_interface* device, uint8_t enable, const uint8_t* reserved);
169 mip_cmd_result mip_gnss_read_rtk_dongle_configuration(mip_interface* device, uint8_t* enable_out, uint8_t* reserved_out);
173 
176 
181 #ifdef __cplusplus
182 } // extern "C"
183 } // namespace C
184 } // namespace mip
185 #endif // __cplusplus
186 
mip::C::mip_gnss_receiver_info_response::receiver_info
mip_gnss_receiver_info_command_info receiver_info[5]
Definition: commands_gnss.h:87
mip::C::MIP_GNSS_BEIDOU_ENABLE_B1
@ MIP_GNSS_BEIDOU_ENABLE_B1
Definition: commands_gnss.h:55
mip::C::mip_gnss_signal_configuration_response::beidou_enable
uint8_t beidou_enable
Bitfield 0: Enable B1, 1: Enable B2, 2: Enable B2A.
Definition: commands_gnss.h:124
mip::C::MIP_GNSS_BEIDOU_ENABLE_B2A
@ MIP_GNSS_BEIDOU_ENABLE_B2A
Definition: commands_gnss.h:57
mip::C::mip_gnss_rtk_dongle_configuration_response
Definition: commands_gnss.h:158
mip
A collection of C++ classes and functions covering the full mip api.
Definition: commands_3dm.c:11
mip::C::mip_gnss_signal_configuration_command::gps_enable
uint8_t gps_enable
Bitfield 0: Enable L1CA, 1: Enable L2C, 2: Enable L5.
Definition: commands_gnss.h:108
mip::C::mip_gnss_read_rtk_dongle_configuration
mip_cmd_result mip_gnss_read_rtk_dongle_configuration(mip_interface *device, uint8_t *enable_out, uint8_t *reserved_out)
Definition: commands_gnss.c:296
mip::C::mip_gnss_signal_configuration_response::gps_enable
uint8_t gps_enable
Bitfield 0: Enable L1CA, 1: Enable L2C, 2: Enable L5.
Definition: commands_gnss.h:121
mip::C::extract_mip_gnss_receiver_info_command_info
void extract_mip_gnss_receiver_info_command_info(microstrain_serializer *serializer, mip_gnss_receiver_info_command_info *self)
Definition: commands_gnss.c:32
mip::C::mip_gnss_load_signal_configuration
mip_cmd_result mip_gnss_load_signal_configuration(mip_interface *device)
Definition: commands_gnss.c:210
mip::C::extract_mip_gnss_signal_configuration_command
void extract_mip_gnss_signal_configuration_command(microstrain_serializer *serializer, mip_gnss_signal_configuration_command *self)
Definition: commands_gnss.c:86
mip::C::mip_gnss_load_rtk_dongle_configuration
mip_cmd_result mip_gnss_load_rtk_dongle_configuration(mip_interface *device)
Definition: commands_gnss.c:338
mip::C::MIP_GNSS_GPS_ENABLE_L2C
@ MIP_GNSS_GPS_ENABLE_L2C
Definition: commands_gnss.h:48
mip::C::mip_gnss_rtk_dongle_configuration_command::enable
uint8_t enable
0 - Disabled, 1- Enabled
Definition: commands_gnss.h:150
mip::C::mip_cmd_result
mip_cmd_result
Represents the status of a MIP command.
Definition: mip_result.h:27
mip::C::mip_gnss_read_signal_configuration
mip_cmd_result mip_gnss_read_signal_configuration(mip_interface *device, uint8_t *gps_enable_out, uint8_t *glonass_enable_out, uint8_t *galileo_enable_out, uint8_t *beidou_enable_out, uint8_t *reserved_out)
Definition: commands_gnss.c:159
mip::C::MIP_GNSS_GPS_ENABLE_L5
@ MIP_GNSS_GPS_ENABLE_L5
Definition: commands_gnss.h:49
mip::C::mip_gnss_save_signal_configuration
mip_cmd_result mip_gnss_save_signal_configuration(mip_interface *device)
Definition: commands_gnss.c:198
mip::C::insert_mip_gnss_rtk_dongle_configuration_response
void insert_mip_gnss_rtk_dongle_configuration_response(microstrain_serializer *serializer, const mip_gnss_rtk_dongle_configuration_response *self)
Definition: commands_gnss.c:261
mip::C::mip_gnss_signal_configuration_response
Definition: commands_gnss.h:119
mip::C::mip_gnss_receiver_info_response::num_receivers
uint8_t num_receivers
Number of physical receivers in the device.
Definition: commands_gnss.h:86
mip_result.h
mip::C::MIP_GNSS_GALILEO_ENABLE_E1
@ MIP_GNSS_GALILEO_ENABLE_E1
Definition: commands_gnss.h:52
mip::C::mip_gnss_receiver_info_command_info::description
char description[32]
Ascii description of receiver. Contains the following info (comma-delimited): Module name/model Fir...
Definition: commands_gnss.h:74
mip::C::mip_gnss_signal_configuration_command::reserved
uint8_t reserved[4]
Definition: commands_gnss.h:112
mip::C::mip_gnss_default_signal_configuration
mip_cmd_result mip_gnss_default_signal_configuration(mip_interface *device)
Definition: commands_gnss.c:222
mip::C::insert_mip_gnss_signal_configuration_command
void insert_mip_gnss_signal_configuration_command(microstrain_serializer *serializer, const mip_gnss_signal_configuration_command *self)
Definition: commands_gnss.c:67
mip::C::mip_gnss_receiver_info_response
Definition: commands_gnss.h:84
mip::C::MIP_REPLY_DESC_GNSS_RTK_DONGLE_CONFIGURATION
@ MIP_REPLY_DESC_GNSS_RTK_DONGLE_CONFIGURATION
Definition: commands_gnss.h:40
mip::C::mip_gnss_signal_configuration_command::galileo_enable
uint8_t galileo_enable
Bitfield 0: Enable E1, 1: Enable E5B, 2: Enable E5A.
Definition: commands_gnss.h:110
mip::C::MIP_CMD_DESC_GNSS_SIGNAL_CONFIGURATION
@ MIP_CMD_DESC_GNSS_SIGNAL_CONFIGURATION
Definition: commands_gnss.h:35
microstrain::C::microstrain_serializer
Structure used for serialization.
Definition: serialization.h:42
mip::C::mip_gnss_signal_configuration_command
Definition: commands_gnss.h:105
mip::C::MIP_GNSS_GPS_ENABLE_L1CA
@ MIP_GNSS_GPS_ENABLE_L1CA
Definition: commands_gnss.h:47
mip::C::mip_gnss_receiver_info_command_info::receiver_id
uint8_t receiver_id
Receiver id: e.g. 1, 2, etc.
Definition: commands_gnss.h:72
mip::C::mip_gnss_signal_configuration_response::glonass_enable
uint8_t glonass_enable
Bitfield 0: Enable L1OF, 1: Enable L2OF.
Definition: commands_gnss.h:122
mip::C::mip_gnss_receiver_info_command_info
Definition: commands_gnss.h:70
mip::C::extract_mip_gnss_signal_configuration_response
void extract_mip_gnss_signal_configuration_response(microstrain_serializer *serializer, mip_gnss_signal_configuration_response *self)
Definition: commands_gnss.c:120
mip::C::insert_mip_gnss_receiver_info_response
void insert_mip_gnss_receiver_info_response(microstrain_serializer *serializer, const mip_gnss_receiver_info_response *self)
mip::C::MIP_CMD_DESC_GNSS_LIST_RECEIVERS
@ MIP_CMD_DESC_GNSS_LIST_RECEIVERS
Definition: commands_gnss.h:34
mip::C::mip_gnss_save_rtk_dongle_configuration
mip_cmd_result mip_gnss_save_rtk_dongle_configuration(mip_interface *device)
Definition: commands_gnss.c:326
mip::C::insert_mip_gnss_receiver_info_command_info
void insert_mip_gnss_receiver_info_command_info(microstrain_serializer *serializer, const mip_gnss_receiver_info_command_info *self)
Definition: commands_gnss.c:22
mip::C::MIP_GNSS_GALILEO_ENABLE_E5A
@ MIP_GNSS_GALILEO_ENABLE_E5A
Definition: commands_gnss.h:54
mip::C::mip_gnss_signal_configuration_response::galileo_enable
uint8_t galileo_enable
Bitfield 0: Enable E1, 1: Enable E5B, 2: Enable E5A.
Definition: commands_gnss.h:123
mip::C::mip_gnss_rtk_dongle_configuration_response::reserved
uint8_t reserved[3]
Definition: commands_gnss.h:161
mip::C::MIP_GNSS_GLONASS_ENABLE_L1OF
@ MIP_GNSS_GLONASS_ENABLE_L1OF
Definition: commands_gnss.h:50
mip::C::mip_interface
State of the interface for communicating with a MIP device.
Definition: mip_interface.h:44
mip::C::mip_gnss_rtk_dongle_configuration_command::reserved
uint8_t reserved[3]
Definition: commands_gnss.h:151
mip::C::mip_gnss_default_rtk_dongle_configuration
mip_cmd_result mip_gnss_default_rtk_dongle_configuration(mip_interface *device)
Definition: commands_gnss.c:350
mip::C::mip_gnss_signal_configuration_command::glonass_enable
uint8_t glonass_enable
Bitfield 0: Enable L1OF, 1: Enable L2OF.
Definition: commands_gnss.h:109
mip::C::mip_gnss_receiver_info_command_info::mip_data_descriptor_set
uint8_t mip_data_descriptor_set
MIP descriptor set associated with this receiver.
Definition: commands_gnss.h:73
mip_interface.h
mip::C::mip_gnss_rtk_dongle_configuration_response::enable
uint8_t enable
Definition: commands_gnss.h:160
common.h
mip::C::extract_mip_gnss_rtk_dongle_configuration_command
void extract_mip_gnss_rtk_dongle_configuration_command(microstrain_serializer *serializer, mip_gnss_rtk_dongle_configuration_command *self)
Definition: commands_gnss.c:247
mip::C::MIP_CMD_DESC_GNSS_RTK_DONGLE_CONFIGURATION
@ MIP_CMD_DESC_GNSS_RTK_DONGLE_CONFIGURATION
Definition: commands_gnss.h:36
mip_descriptors.h
mip::C::mip_gnss_receiver_info_command
struct mip_gnss_receiver_info_command mip_gnss_receiver_info_command
No parameters (empty struct not allowed in C)
Definition: commands_gnss.h:82
mip::C::MIP_REPLY_DESC_GNSS_SIGNAL_CONFIGURATION
@ MIP_REPLY_DESC_GNSS_SIGNAL_CONFIGURATION
Definition: commands_gnss.h:39
mip::C::MIP_GNSS_BEIDOU_ENABLE_B2
@ MIP_GNSS_BEIDOU_ENABLE_B2
Definition: commands_gnss.h:56
mip::C::mip_gnss_signal_configuration_response::reserved
uint8_t reserved[4]
Definition: commands_gnss.h:125
mip::C::extract_mip_gnss_rtk_dongle_configuration_response
void extract_mip_gnss_rtk_dongle_configuration_response(microstrain_serializer *serializer, mip_gnss_rtk_dongle_configuration_response *self)
Definition: commands_gnss.c:269
mip::C::mip_gnss_receiver_info
mip_cmd_result mip_gnss_receiver_info(mip_interface *device, uint8_t *num_receivers_out, uint8_t num_receivers_out_max, mip_gnss_receiver_info_command_info *receiver_info_out)
Definition: commands_gnss.c:43
mip::C::mip_gnss_write_signal_configuration
mip_cmd_result mip_gnss_write_signal_configuration(mip_interface *device, uint8_t gps_enable, uint8_t glonass_enable, uint8_t galileo_enable, uint8_t beidou_enable, const uint8_t *reserved)
Definition: commands_gnss.c:135
mip::C::MIP_GNSS_GLONASS_ENABLE_L2OF
@ MIP_GNSS_GLONASS_ENABLE_L2OF
Definition: commands_gnss.h:51
mip::C::mip_gnss_rtk_dongle_configuration_command
Definition: commands_gnss.h:147
mip::C::mip_gnss_signal_configuration_command::beidou_enable
uint8_t beidou_enable
Bitfield 0: Enable B1, 1: Enable B2, 2: Enable B2A.
Definition: commands_gnss.h:111
mip::C::extract_mip_gnss_receiver_info_response
void extract_mip_gnss_receiver_info_response(microstrain_serializer *serializer, mip_gnss_receiver_info_response *self)
mip::C::mip_gnss_write_rtk_dongle_configuration
mip_cmd_result mip_gnss_write_rtk_dongle_configuration(mip_interface *device, uint8_t enable, const uint8_t *reserved)
Definition: commands_gnss.c:278
mip::C::insert_mip_gnss_rtk_dongle_configuration_command
void insert_mip_gnss_rtk_dongle_configuration_command(microstrain_serializer *serializer, const mip_gnss_rtk_dongle_configuration_command *self)
Definition: commands_gnss.c:234
mip::C::MIP_GNSS_GALILEO_ENABLE_E5B
@ MIP_GNSS_GALILEO_ENABLE_E5B
Definition: commands_gnss.h:53
mip::C::insert_mip_gnss_signal_configuration_response
void insert_mip_gnss_signal_configuration_response(microstrain_serializer *serializer, const mip_gnss_signal_configuration_response *self)
Definition: commands_gnss.c:106
mip::C::mip_function_selector
mip_function_selector
Definition: mip_descriptors.h:42
mip::C::MIP_GNSS_CMD_DESC_SET
@ MIP_GNSS_CMD_DESC_SET
Definition: commands_gnss.h:32
mip::C::MIP_REPLY_DESC_GNSS_LIST_RECEIVERS
@ MIP_REPLY_DESC_GNSS_LIST_RECEIVERS
Definition: commands_gnss.h:38