MIP_SDK  latest-2-g34f3e39
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 
38 
43 };
44 
46 // Shared Type Definitions
48 
49 enum { MIP_GNSS_GPS_ENABLE_L1CA = 0x0001 };
50 enum { MIP_GNSS_GPS_ENABLE_L2C = 0x0002 };
51 enum { MIP_GNSS_GPS_ENABLE_L5 = 0x0004 };
52 enum { MIP_GNSS_GLONASS_ENABLE_L1OF = 0x0001 };
53 enum { MIP_GNSS_GLONASS_ENABLE_L2OF = 0x0002 };
54 enum { MIP_GNSS_GALILEO_ENABLE_E1 = 0x0001 };
55 enum { MIP_GNSS_GALILEO_ENABLE_E5B = 0x0002 };
56 enum { MIP_GNSS_GALILEO_ENABLE_E5A = 0x0004 };
57 enum { MIP_GNSS_BEIDOU_ENABLE_B1 = 0x0001 };
58 enum { MIP_GNSS_BEIDOU_ENABLE_B2 = 0x0002 };
59 enum { MIP_GNSS_BEIDOU_ENABLE_B2A = 0x0004 };
60 
62 // Mip Fields
64 
71 
73 {
74  uint8_t receiver_id;
76  char description[32];
77 };
79 
82 
83 
85 
87 {
88  uint8_t num_receivers;
90 };
92 
95 
96 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);
97 
106 
108 {
110  uint8_t gps_enable;
111  uint8_t glonass_enable;
112  uint8_t galileo_enable;
113  uint8_t beidou_enable;
114  uint8_t reserved[4];
115 };
117 
120 
122 {
123  uint8_t gps_enable;
124  uint8_t glonass_enable;
125  uint8_t galileo_enable;
126  uint8_t beidou_enable;
127  uint8_t reserved[4];
128 };
130 
133 
134 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);
135 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);
139 
151 
153 {
155  uint8_t enable;
156  uint8_t type;
157  uint32_t current_key_tow;
158  uint16_t current_key_week;
159  uint8_t current_key[32];
160  uint32_t next_key_tow;
161  uint16_t next_key_week;
162  uint8_t next_key[32];
163 };
165 
168 
170 {
171  uint8_t enable;
172  uint8_t type;
173  uint32_t current_key_tow;
174  uint16_t current_key_week;
175  uint8_t current_key[32];
176  uint32_t next_key_tow;
177  uint16_t next_key_week;
178  uint8_t next_key[32];
179 };
181 
184 
185 mip_cmd_result mip_gnss_write_spartn_configuration(mip_interface* device, uint8_t enable, uint8_t type, uint32_t current_key_tow, uint16_t current_key_week, const uint8_t* current_key, uint32_t next_key_tow, uint16_t next_key_week, const uint8_t* next_key);
186 mip_cmd_result mip_gnss_read_spartn_configuration(mip_interface* device, uint8_t* enable_out, uint8_t* type_out, uint32_t* current_key_tow_out, uint16_t* current_key_week_out, uint8_t* current_key_out, uint32_t* next_key_tow_out, uint16_t* next_key_week_out, uint8_t* next_key_out);
190 
199 
201 {
203  uint8_t enable;
204  uint8_t reserved[3];
205 };
207 
210 
212 {
213  uint8_t enable;
214  uint8_t reserved[3];
215 };
217 
220 
221 mip_cmd_result mip_gnss_write_rtk_dongle_configuration(mip_interface* device, uint8_t enable, const uint8_t* reserved);
222 mip_cmd_result mip_gnss_read_rtk_dongle_configuration(mip_interface* device, uint8_t* enable_out, uint8_t* reserved_out);
226 
229 
234 #ifdef __cplusplus
235 } // extern "C"
236 } // namespace C
237 } // namespace mip
238 #endif // __cplusplus
239 
mip::C::mip_gnss_receiver_info_response::receiver_info
mip_gnss_receiver_info_command_info receiver_info[5]
Definition: commands_gnss.h:89
mip::C::MIP_REPLY_DESC_GNSS_SPARTN_CONFIGURATION
@ MIP_REPLY_DESC_GNSS_SPARTN_CONFIGURATION
Definition: commands_gnss.h:42
mip::C::MIP_GNSS_BEIDOU_ENABLE_B1
@ MIP_GNSS_BEIDOU_ENABLE_B1
Definition: commands_gnss.h:57
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:126
mip::C::MIP_GNSS_BEIDOU_ENABLE_B2A
@ MIP_GNSS_BEIDOU_ENABLE_B2A
Definition: commands_gnss.h:59
mip::C::mip_gnss_rtk_dongle_configuration_response
Definition: commands_gnss.h:211
mip::C::mip_gnss_spartn_configuration_command::next_key
uint8_t next_key[32]
32 character string of ASCII hex valuesfor the next key (e.g. "bc" for 0xBC)
Definition: commands_gnss.h:162
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:110
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:509
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:123
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:551
mip::C::MIP_GNSS_GPS_ENABLE_L2C
@ MIP_GNSS_GPS_ENABLE_L2C
Definition: commands_gnss.h:50
mip::C::mip_gnss_spartn_configuration_command::enable
uint8_t enable
Enable/Disable the SPARTN subsystem (0 = Disabled, 1 = Enabled)
Definition: commands_gnss.h:155
mip::C::mip_gnss_spartn_configuration_command::current_key
uint8_t current_key[32]
32 character string of ASCII hex values for the current key (e.g. "bc" for 0xBC)
Definition: commands_gnss.h:159
mip::C::mip_gnss_load_spartn_configuration
mip_cmd_result mip_gnss_load_spartn_configuration(mip_interface *device)
Definition: commands_gnss.c:423
mip::C::mip_gnss_spartn_configuration_response::current_key_tow
uint32_t current_key_tow
The GPS time of week the current key is valid until.
Definition: commands_gnss.h:173
mip::C::mip_gnss_rtk_dongle_configuration_command::enable
uint8_t enable
0 - Disabled, 1- Enabled
Definition: commands_gnss.h:203
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:51
mip::C::mip_gnss_spartn_configuration_command
Definition: commands_gnss.h:152
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::mip_gnss_spartn_configuration_response::next_key
uint8_t next_key[32]
32 character string of ASCII hex valuesfor the next key (e.g. "bc" for 0xBC)
Definition: commands_gnss.h:178
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:474
mip::C::mip_gnss_spartn_configuration_command::current_key_week
uint16_t current_key_week
The GPS week number the current key is valid until.
Definition: commands_gnss.h:158
mip::C::mip_gnss_signal_configuration_response
Definition: commands_gnss.h:121
mip::C::mip_gnss_receiver_info_response::num_receivers
uint8_t num_receivers
Number of physical receivers in the device.
Definition: commands_gnss.h:88
mip_result.h
mip::C::MIP_CMD_DESC_GNSS_SPARTN_CONFIGURATION
@ MIP_CMD_DESC_GNSS_SPARTN_CONFIGURATION
Definition: commands_gnss.h:37
mip::C::MIP_GNSS_GALILEO_ENABLE_E1
@ MIP_GNSS_GALILEO_ENABLE_E1
Definition: commands_gnss.h:54
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:76
mip::C::mip_gnss_signal_configuration_command::reserved
uint8_t reserved[4]
Definition: commands_gnss.h:114
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:86
mip::C::MIP_REPLY_DESC_GNSS_RTK_DONGLE_CONFIGURATION
@ MIP_REPLY_DESC_GNSS_RTK_DONGLE_CONFIGURATION
Definition: commands_gnss.h:41
mip::C::extract_mip_gnss_spartn_configuration_response
void extract_mip_gnss_spartn_configuration_response(microstrain_serializer *serializer, mip_gnss_spartn_configuration_response *self)
Definition: commands_gnss.c:308
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:112
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:107
mip::C::mip_gnss_default_spartn_configuration
mip_cmd_result mip_gnss_default_spartn_configuration(mip_interface *device)
Definition: commands_gnss.c:435
mip::C::mip_gnss_spartn_configuration_command::current_key_tow
uint32_t current_key_tow
The GPS time of week the current key is valid until.
Definition: commands_gnss.h:157
mip::C::MIP_GNSS_GPS_ENABLE_L1CA
@ MIP_GNSS_GPS_ENABLE_L1CA
Definition: commands_gnss.h:49
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:74
mip::C::mip_gnss_spartn_configuration_response
Definition: commands_gnss.h:169
mip::C::mip_gnss_signal_configuration_response::glonass_enable
uint8_t glonass_enable
Bitfield 0: Enable L1OF, 1: Enable L2OF.
Definition: commands_gnss.h:124
mip::C::mip_gnss_receiver_info_command_info
Definition: commands_gnss.h:72
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:539
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:56
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:125
mip::C::mip_gnss_rtk_dongle_configuration_response::reserved
uint8_t reserved[3]
Definition: commands_gnss.h:214
mip::C::MIP_GNSS_GLONASS_ENABLE_L1OF
@ MIP_GNSS_GLONASS_ENABLE_L1OF
Definition: commands_gnss.h:52
mip::C::mip_interface
State of the interface for communicating with a MIP device.
Definition: mip_interface.h:44
mip::C::mip_gnss_spartn_configuration_response::current_key
uint8_t current_key[32]
32 character string of ASCII hex values for the current key (e.g. "bc" for 0xBC)
Definition: commands_gnss.h:175
mip::C::mip_gnss_rtk_dongle_configuration_command::reserved
uint8_t reserved[3]
Definition: commands_gnss.h:204
mip::C::mip_gnss_default_rtk_dongle_configuration
mip_cmd_result mip_gnss_default_rtk_dongle_configuration(mip_interface *device)
Definition: commands_gnss.c:563
mip::C::mip_gnss_signal_configuration_command::glonass_enable
uint8_t glonass_enable
Bitfield 0: Enable L1OF, 1: Enable L2OF.
Definition: commands_gnss.h:111
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:75
mip_interface.h
mip::C::mip_gnss_rtk_dongle_configuration_response::enable
uint8_t enable
Definition: commands_gnss.h:213
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:460
mip::C::mip_gnss_spartn_configuration_response::enable
uint8_t enable
Enable/Disable the SPARTN subsystem (0 = Disabled, 1 = Enabled)
Definition: commands_gnss.h:171
mip::C::mip_gnss_spartn_configuration_response::next_key_tow
uint32_t next_key_tow
The GPS time of week the next key is valid until.
Definition: commands_gnss.h:176
mip::C::MIP_CMD_DESC_GNSS_RTK_DONGLE_CONFIGURATION
@ MIP_CMD_DESC_GNSS_RTK_DONGLE_CONFIGURATION
Definition: commands_gnss.h:36
mip::C::mip_gnss_spartn_configuration_response::next_key_week
uint16_t next_key_week
The GPS week number the next key is valid until.
Definition: commands_gnss.h:177
mip::C::mip_gnss_read_spartn_configuration
mip_cmd_result mip_gnss_read_spartn_configuration(mip_interface *device, uint8_t *enable_out, uint8_t *type_out, uint32_t *current_key_tow_out, uint16_t *current_key_week_out, uint8_t *current_key_out, uint32_t *next_key_tow_out, uint16_t *next_key_week_out, uint8_t *next_key_out)
Definition: commands_gnss.c:362
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:84
mip::C::MIP_REPLY_DESC_GNSS_SIGNAL_CONFIGURATION
@ MIP_REPLY_DESC_GNSS_SIGNAL_CONFIGURATION
Definition: commands_gnss.h:40
mip::C::mip_gnss_spartn_configuration_command::next_key_week
uint16_t next_key_week
The GPS week number the next key is valid until.
Definition: commands_gnss.h:161
mip::C::MIP_GNSS_BEIDOU_ENABLE_B2
@ MIP_GNSS_BEIDOU_ENABLE_B2
Definition: commands_gnss.h:58
mip::C::mip_gnss_signal_configuration_response::reserved
uint8_t reserved[4]
Definition: commands_gnss.h:127
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:482
mip::C::extract_mip_gnss_spartn_configuration_command
void extract_mip_gnss_spartn_configuration_command(microstrain_serializer *serializer, mip_gnss_spartn_configuration_command *self)
Definition: commands_gnss.c:260
mip::C::mip_gnss_spartn_configuration_response::current_key_week
uint16_t current_key_week
The GPS week number the current key is valid until.
Definition: commands_gnss.h:174
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_spartn_configuration_response::type
uint8_t type
Connection type (0 - None, 1 = Network, 2 = L-Band)
Definition: commands_gnss.h:172
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:53
mip::C::mip_gnss_write_spartn_configuration
mip_cmd_result mip_gnss_write_spartn_configuration(mip_interface *device, uint8_t enable, uint8_t type, uint32_t current_key_tow, uint16_t current_key_week, const uint8_t *current_key, uint32_t next_key_tow, uint16_t next_key_week, const uint8_t *next_key)
Definition: commands_gnss.c:330
mip::C::insert_mip_gnss_spartn_configuration_command
void insert_mip_gnss_spartn_configuration_command(microstrain_serializer *serializer, const mip_gnss_spartn_configuration_command *self)
Definition: commands_gnss.c:234
mip::C::mip_gnss_rtk_dongle_configuration_command
Definition: commands_gnss.h:200
mip::C::insert_mip_gnss_spartn_configuration_response
void insert_mip_gnss_spartn_configuration_response(microstrain_serializer *serializer, const mip_gnss_spartn_configuration_response *self)
Definition: commands_gnss.c:287
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:113
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_spartn_configuration_command::type
uint8_t type
Connection type (0 - None, 1 = Network, 2 = L-Band)
Definition: commands_gnss.h:156
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:491
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:447
mip::C::MIP_GNSS_GALILEO_ENABLE_E5B
@ MIP_GNSS_GALILEO_ENABLE_E5B
Definition: commands_gnss.h:55
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_gnss_save_spartn_configuration
mip_cmd_result mip_gnss_save_spartn_configuration(mip_interface *device)
Definition: commands_gnss.c:411
mip::C::mip_gnss_spartn_configuration_command::next_key_tow
uint32_t next_key_tow
The GPS time of week the next key is valid until.
Definition: commands_gnss.h:160
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:39