MIP_SDK  latest-2-g34f3e39
MicroStrain Communications Library for embedded systems
commands_base.hpp
Go to the documentation of this file.
1 #pragma once
2 
5 #include <mip/mip_result.hpp>
6 #include <mip/mip_interface.hpp>
7 
8 #include <stdint.h>
9 #include <stddef.h>
10 
11 namespace mip {
12 namespace C {
13 struct mip_interface;
14 } // namespace C
15 
16 namespace commands_base {
17 
24 
26 // Descriptors
28 
29 enum
30 {
32 
33  CMD_PING = 0x01,
38  CMD_RESUME = 0x06,
44 
53 };
54 
56 // Shared Type Definitions
58 
60 {
62  uint16_t firmware_version = 0;
63  char model_name[16] = {0};
64  char model_number[16] = {0};
65  char serial_number[16] = {0};
66  char lot_number[16] = {0};
67  char device_options[16] = {0};
68 
70  void insert(Serializer& serializer) const;
71  void extract(Serializer& serializer);
72 
73 };
74 enum class TimeFormat : uint8_t
75 {
76  GPS = 1,
77 };
78 
79 struct CommandedTestBitsGq7 : Bitfield<CommandedTestBitsGq7>
80 {
81  typedef uint32_t Type;
82  enum _enumType : uint32_t
83  {
84  NONE = 0x00000000,
85  GENERAL_HARDWARE_FAULT = 0x00000001,
86  GENERAL_FIRMWARE_FAULT = 0x00000002,
87  TIMING_OVERLOAD = 0x00000004,
88  BUFFER_OVERRUN = 0x00000008,
89  RESERVED = 0x000000F0,
90  IPC_IMU_FAULT = 0x00000100,
91  IPC_NAV_FAULT = 0x00000200,
92  IPC_GNSS_FAULT = 0x00000400,
93  COMMS_FAULT = 0x00000800,
94  IMU_ACCEL_FAULT = 0x00001000,
95  IMU_GYRO_FAULT = 0x00002000,
96  IMU_MAG_FAULT = 0x00004000,
97  IMU_PRESS_FAULT = 0x00008000,
98  IMU_RESERVED = 0x00030000,
99  IMU_CAL_ERROR = 0x00040000,
100  IMU_GENERAL_FAULT = 0x00080000,
101  FILT_RESERVED = 0x00300000,
102  FILT_SOLUTION_FAULT = 0x00400000,
103  FILT_GENERAL_FAULT = 0x00800000,
104  GNSS_RECEIVER1_FAULT = 0x01000000,
105  GNSS_ANTENNA1_FAULT = 0x02000000,
106  GNSS_RECEIVER2_FAULT = 0x04000000,
107  GNSS_ANTENNA2_FAULT = 0x08000000,
108  GNSS_RTCM_FAILURE = 0x10000000,
109  GNSS_RTK_FAULT = 0x20000000,
110  GNSS_SOLUTION_FAULT = 0x40000000,
111  GNSS_GENERAL_FAULT = 0x80000000,
112  ALL = 0xFFFFFFFF,
113  };
114  uint32_t value = NONE;
115 
117  CommandedTestBitsGq7(int val) : value((uint32_t)val) {}
118  operator uint32_t() const { return value; }
119  CommandedTestBitsGq7& operator=(uint32_t val) { value = val; return *this; }
120  CommandedTestBitsGq7& operator=(int val) { value = uint32_t(val); return *this; }
121  CommandedTestBitsGq7& operator|=(uint32_t val) { return *this = value | val; }
122  CommandedTestBitsGq7& operator&=(uint32_t val) { return *this = value & val; }
123 
124  bool generalHardwareFault() const { return (value & GENERAL_HARDWARE_FAULT) > 0; }
126  bool generalFirmwareFault() const { return (value & GENERAL_FIRMWARE_FAULT) > 0; }
128  bool timingOverload() const { return (value & TIMING_OVERLOAD) > 0; }
129  void timingOverload(bool val) { value &= ~TIMING_OVERLOAD; if(val) value |= TIMING_OVERLOAD; }
130  bool bufferOverrun() const { return (value & BUFFER_OVERRUN) > 0; }
131  void bufferOverrun(bool val) { value &= ~BUFFER_OVERRUN; if(val) value |= BUFFER_OVERRUN; }
132  uint32_t reserved() const { return (value & RESERVED) >> 4; }
133  void reserved(uint32_t val) { value = (value & ~RESERVED) | (val << 4); }
134  bool ipcImuFault() const { return (value & IPC_IMU_FAULT) > 0; }
135  void ipcImuFault(bool val) { value &= ~IPC_IMU_FAULT; if(val) value |= IPC_IMU_FAULT; }
136  bool ipcNavFault() const { return (value & IPC_NAV_FAULT) > 0; }
137  void ipcNavFault(bool val) { value &= ~IPC_NAV_FAULT; if(val) value |= IPC_NAV_FAULT; }
138  bool ipcGnssFault() const { return (value & IPC_GNSS_FAULT) > 0; }
139  void ipcGnssFault(bool val) { value &= ~IPC_GNSS_FAULT; if(val) value |= IPC_GNSS_FAULT; }
140  bool commsFault() const { return (value & COMMS_FAULT) > 0; }
141  void commsFault(bool val) { value &= ~COMMS_FAULT; if(val) value |= COMMS_FAULT; }
142  bool imuAccelFault() const { return (value & IMU_ACCEL_FAULT) > 0; }
143  void imuAccelFault(bool val) { value &= ~IMU_ACCEL_FAULT; if(val) value |= IMU_ACCEL_FAULT; }
144  bool imuGyroFault() const { return (value & IMU_GYRO_FAULT) > 0; }
145  void imuGyroFault(bool val) { value &= ~IMU_GYRO_FAULT; if(val) value |= IMU_GYRO_FAULT; }
146  bool imuMagFault() const { return (value & IMU_MAG_FAULT) > 0; }
147  void imuMagFault(bool val) { value &= ~IMU_MAG_FAULT; if(val) value |= IMU_MAG_FAULT; }
148  bool imuPressFault() const { return (value & IMU_PRESS_FAULT) > 0; }
149  void imuPressFault(bool val) { value &= ~IMU_PRESS_FAULT; if(val) value |= IMU_PRESS_FAULT; }
150  uint32_t imuReserved() const { return (value & IMU_RESERVED) >> 16; }
151  void imuReserved(uint32_t val) { value = (value & ~IMU_RESERVED) | (val << 16); }
152  bool imuCalError() const { return (value & IMU_CAL_ERROR) > 0; }
153  void imuCalError(bool val) { value &= ~IMU_CAL_ERROR; if(val) value |= IMU_CAL_ERROR; }
154  bool imuGeneralFault() const { return (value & IMU_GENERAL_FAULT) > 0; }
155  void imuGeneralFault(bool val) { value &= ~IMU_GENERAL_FAULT; if(val) value |= IMU_GENERAL_FAULT; }
156  uint32_t filtReserved() const { return (value & FILT_RESERVED) >> 20; }
157  void filtReserved(uint32_t val) { value = (value & ~FILT_RESERVED) | (val << 20); }
158  bool filtSolutionFault() const { return (value & FILT_SOLUTION_FAULT) > 0; }
160  bool filtGeneralFault() const { return (value & FILT_GENERAL_FAULT) > 0; }
162  bool gnssReceiver1Fault() const { return (value & GNSS_RECEIVER1_FAULT) > 0; }
164  bool gnssAntenna1Fault() const { return (value & GNSS_ANTENNA1_FAULT) > 0; }
166  bool gnssReceiver2Fault() const { return (value & GNSS_RECEIVER2_FAULT) > 0; }
168  bool gnssAntenna2Fault() const { return (value & GNSS_ANTENNA2_FAULT) > 0; }
170  bool gnssRtcmFailure() const { return (value & GNSS_RTCM_FAILURE) > 0; }
171  void gnssRtcmFailure(bool val) { value &= ~GNSS_RTCM_FAILURE; if(val) value |= GNSS_RTCM_FAILURE; }
172  bool gnssRtkFault() const { return (value & GNSS_RTK_FAULT) > 0; }
173  void gnssRtkFault(bool val) { value &= ~GNSS_RTK_FAULT; if(val) value |= GNSS_RTK_FAULT; }
174  bool gnssSolutionFault() const { return (value & GNSS_SOLUTION_FAULT) > 0; }
176  bool gnssGeneralFault() const { return (value & GNSS_GENERAL_FAULT) > 0; }
178  bool allSet() const { return value == ALL; }
179  void setAll() { value |= ALL; }
180 };
181 
183 // Mip Fields
185 
195 
196 struct Ping
197 {
199  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
200  static constexpr const uint8_t FIELD_DESCRIPTOR = ::mip::commands_base::CMD_PING;
202  static constexpr const char* NAME = "Ping";
203  static constexpr const char* DOC_NAME = "Ping";
204  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
205 
206  auto asTuple() const
207  {
208  return std::make_tuple();
209  }
210 
211  auto asTuple()
212  {
213  return std::make_tuple();
214  }
215 
217  void insert(Serializer& serializer) const;
218  void extract(Serializer& serializer);
219 
220  typedef void Response;
221 };
223 
235 
236 struct SetIdle
237 {
239  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
240  static constexpr const uint8_t FIELD_DESCRIPTOR = ::mip::commands_base::CMD_SET_TO_IDLE;
242  static constexpr const char* NAME = "SetIdle";
243  static constexpr const char* DOC_NAME = "Set to idle";
244  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
245 
246  auto asTuple() const
247  {
248  return std::make_tuple();
249  }
250 
251  auto asTuple()
252  {
253  return std::make_tuple();
254  }
255 
257  void insert(Serializer& serializer) const;
258  void extract(Serializer& serializer);
259 
260  typedef void Response;
261 };
263 
271 
273 {
275  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
278  static constexpr const char* NAME = "GetDeviceInfo";
279  static constexpr const char* DOC_NAME = "Get device information";
280  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
281 
282  auto asTuple() const
283  {
284  return std::make_tuple();
285  }
286 
287  auto asTuple()
288  {
289  return std::make_tuple();
290  }
291 
293  void insert(Serializer& serializer) const;
294  void extract(Serializer& serializer);
295 
296  struct Response
297  {
300 
302  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
305  static constexpr const char* NAME = "GetDeviceInfo::Response";
306  static constexpr const char* DOC_NAME = "Get device information Response";
307  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
308 
309  auto asTuple() const
310  {
311  return std::make_tuple(device_info);
312  }
313 
314  auto asTuple()
315  {
316  return std::make_tuple(std::ref(device_info));
317  }
318 
320  void insert(Serializer& serializer) const;
321  void extract(Serializer& serializer);
322 
323  };
324 };
325 TypedResult<GetDeviceInfo> getDeviceInfo(C::mip_interface& device, BaseDeviceInfo* deviceInfoOut);
326 
337 
339 {
341  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
344  static constexpr const char* NAME = "GetDeviceDescriptors";
345  static constexpr const char* DOC_NAME = "Get device descriptors";
346  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
347 
348  auto asTuple() const
349  {
350  return std::make_tuple();
351  }
352 
353  auto asTuple()
354  {
355  return std::make_tuple();
356  }
357 
359  void insert(Serializer& serializer) const;
360  void extract(Serializer& serializer);
361 
362  struct Response
363  {
365  uint16_t descriptors[253] = {0};
366  uint8_t descriptors_count = 0;
367 
369  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
372  static constexpr const char* NAME = "GetDeviceDescriptors::Response";
373  static constexpr const char* DOC_NAME = "Get device descriptors Response";
374  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
375 
376  auto asTuple() const
377  {
378  return std::make_tuple(descriptors,descriptors_count);
379  }
380 
381  auto asTuple()
382  {
383  return std::make_tuple(std::ref(descriptors),std::ref(descriptors_count));
384  }
385 
387  void insert(Serializer& serializer) const;
388  void extract(Serializer& serializer);
389 
390  };
391 };
392 TypedResult<GetDeviceDescriptors> getDeviceDescriptors(C::mip_interface& device, uint16_t* descriptorsOut, size_t descriptorsOutMax, uint8_t* descriptorsOutCount);
393 
406 
408 {
410  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
413  static constexpr const char* NAME = "BuiltInTest";
414  static constexpr const char* DOC_NAME = "Built in test";
415  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
416 
417  auto asTuple() const
418  {
419  return std::make_tuple();
420  }
421 
422  auto asTuple()
423  {
424  return std::make_tuple();
425  }
426 
428  void insert(Serializer& serializer) const;
429  void extract(Serializer& serializer);
430 
431  struct Response
432  {
434  uint32_t result = 0;
435 
437  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
440  static constexpr const char* NAME = "BuiltInTest::Response";
441  static constexpr const char* DOC_NAME = "Built in test Response";
442  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
443 
444  auto asTuple() const
445  {
446  return std::make_tuple(result);
447  }
448 
449  auto asTuple()
450  {
451  return std::make_tuple(std::ref(result));
452  }
453 
455  void insert(Serializer& serializer) const;
456  void extract(Serializer& serializer);
457 
458  };
459 };
460 TypedResult<BuiltInTest> builtInTest(C::mip_interface& device, uint32_t* resultOut);
461 
471 
472 struct Resume
473 {
475  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
476  static constexpr const uint8_t FIELD_DESCRIPTOR = ::mip::commands_base::CMD_RESUME;
478  static constexpr const char* NAME = "Resume";
479  static constexpr const char* DOC_NAME = "Resume";
480  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
481 
482  auto asTuple() const
483  {
484  return std::make_tuple();
485  }
486 
487  auto asTuple()
488  {
489  return std::make_tuple();
490  }
491 
493  void insert(Serializer& serializer) const;
494  void extract(Serializer& serializer);
495 
496  typedef void Response;
497 };
499 
510 
512 {
514  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
517  static constexpr const char* NAME = "GetExtendedDescriptors";
518  static constexpr const char* DOC_NAME = "Get device descriptors (extended)";
519  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
520 
521  auto asTuple() const
522  {
523  return std::make_tuple();
524  }
525 
526  auto asTuple()
527  {
528  return std::make_tuple();
529  }
530 
532  void insert(Serializer& serializer) const;
533  void extract(Serializer& serializer);
534 
535  struct Response
536  {
538  uint16_t descriptors[253] = {0};
539  uint8_t descriptors_count = 0;
540 
542  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
545  static constexpr const char* NAME = "GetExtendedDescriptors::Response";
546  static constexpr const char* DOC_NAME = "Get device descriptors (extended) Response";
547  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
548 
549  auto asTuple() const
550  {
551  return std::make_tuple(descriptors,descriptors_count);
552  }
553 
554  auto asTuple()
555  {
556  return std::make_tuple(std::ref(descriptors),std::ref(descriptors_count));
557  }
558 
560  void insert(Serializer& serializer) const;
561  void extract(Serializer& serializer);
562 
563  };
564 };
565 TypedResult<GetExtendedDescriptors> getExtendedDescriptors(C::mip_interface& device, uint16_t* descriptorsOut, size_t descriptorsOutMax, uint8_t* descriptorsOutCount);
566 
576 
578 {
580  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
583  static constexpr const char* NAME = "ContinuousBit";
584  static constexpr const char* DOC_NAME = "Continuous built-in test";
585  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
586 
587  auto asTuple() const
588  {
589  return std::make_tuple();
590  }
591 
592  auto asTuple()
593  {
594  return std::make_tuple();
595  }
596 
598  void insert(Serializer& serializer) const;
599  void extract(Serializer& serializer);
600 
601  struct Response
602  {
604  uint8_t result[16] = {0};
605 
607  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
610  static constexpr const char* NAME = "ContinuousBit::Response";
611  static constexpr const char* DOC_NAME = "Continuous built-in test Response";
612  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
613 
614  auto asTuple() const
615  {
616  return std::make_tuple(result);
617  }
618 
619  auto asTuple()
620  {
621  return std::make_tuple(std::ref(result));
622  }
623 
625  void insert(Serializer& serializer) const;
626  void extract(Serializer& serializer);
627 
628  };
629 };
630 TypedResult<ContinuousBit> continuousBit(C::mip_interface& device, uint8_t* resultOut);
631 
652 
653 struct CommSpeed
654 {
655  static constexpr const uint32_t ALL_PORTS = 0;
657  FunctionSelector function = static_cast<FunctionSelector>(0);
658  uint8_t port = 0;
659  uint32_t baud = 0;
660 
662  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
663  static constexpr const uint8_t FIELD_DESCRIPTOR = ::mip::commands_base::CMD_COMM_SPEED;
665  static constexpr const char* NAME = "CommSpeed";
666  static constexpr const char* DOC_NAME = "Comm Port Speed";
667  static constexpr const bool HAS_FUNCTION_SELECTOR = true;
668 
669  auto asTuple() const
670  {
671  return std::make_tuple(port,baud);
672  }
673 
674  auto asTuple()
675  {
676  return std::make_tuple(std::ref(port),std::ref(baud));
677  }
678 
680  {
681  CommSpeed cmd;
682  cmd.function = function;
683  cmd.port = 0;
684  return cmd;
685  }
686 
688  void insert(Serializer& serializer) const;
689  void extract(Serializer& serializer);
690 
691  struct Response
692  {
694  uint8_t port = 0;
695  uint32_t baud = 0;
696 
698  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
701  static constexpr const char* NAME = "CommSpeed::Response";
702  static constexpr const char* DOC_NAME = "Comm Port Speed Response";
703  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
704 
705  auto asTuple() const
706  {
707  return std::make_tuple(port,baud);
708  }
709 
710  auto asTuple()
711  {
712  return std::make_tuple(std::ref(port),std::ref(baud));
713  }
714 
716  void insert(Serializer& serializer) const;
717  void extract(Serializer& serializer);
718 
719  };
720 };
721 TypedResult<CommSpeed> writeCommSpeed(C::mip_interface& device, uint8_t port, uint32_t baud);
722 TypedResult<CommSpeed> readCommSpeed(C::mip_interface& device, uint8_t port, uint32_t* baudOut);
726 
737 
739 {
740  enum class FieldId : uint8_t
741  {
742  WEEK_NUMBER = 1,
743  TIME_OF_WEEK = 2,
744  };
745 
747  FunctionSelector function = static_cast<FunctionSelector>(0);
748  FieldId field_id = static_cast<FieldId>(0);
749  uint32_t value = 0;
750 
752  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
755  static constexpr const char* NAME = "GpsTimeUpdate";
756  static constexpr const char* DOC_NAME = "GPS Time Update Command";
757  static constexpr const bool HAS_FUNCTION_SELECTOR = true;
758 
759  auto asTuple() const
760  {
761  return std::make_tuple(field_id,value);
762  }
763 
764  auto asTuple()
765  {
766  return std::make_tuple(std::ref(field_id),std::ref(value));
767  }
768 
770  {
771  GpsTimeUpdate cmd;
772  cmd.function = function;
773  return cmd;
774  }
775 
777  void insert(Serializer& serializer) const;
778  void extract(Serializer& serializer);
779 
780  typedef void Response;
781 };
783 
793 
794 struct SoftReset
795 {
797  static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_base::DESCRIPTOR_SET;
798  static constexpr const uint8_t FIELD_DESCRIPTOR = ::mip::commands_base::CMD_SOFT_RESET;
800  static constexpr const char* NAME = "SoftReset";
801  static constexpr const char* DOC_NAME = "Reset device";
802  static constexpr const bool HAS_FUNCTION_SELECTOR = false;
803 
804  auto asTuple() const
805  {
806  return std::make_tuple();
807  }
808 
809  auto asTuple()
810  {
811  return std::make_tuple();
812  }
813 
815  void insert(Serializer& serializer) const;
816  void extract(Serializer& serializer);
817 
818  typedef void Response;
819 };
821 
824 
829 } // namespace commands_base
830 } // namespace mip
831 
mip::commands_base::softReset
TypedResult< SoftReset > softReset(C::mip_interface &device)
Definition: commands_base.cpp:470
mip::commands_base::getDeviceDescriptors
TypedResult< GetDeviceDescriptors > getDeviceDescriptors(C::mip_interface &device, uint16_t *descriptorsOut, size_t descriptorsOutMax, uint8_t *descriptorsOutCount)
Definition: commands_base.cpp:151
mip::commands_base::REPLY_GPS_CORRELATION_SECONDS
@ REPLY_GPS_CORRELATION_SECONDS
Definition: commands_base.hpp:49
mip::commands_base::CommandedTestBitsGq7::gnssReceiver1Fault
void gnssReceiver1Fault(bool val)
Definition: commands_base.hpp:163
mip::commands_base::CommandedTestBitsGq7::COMMS_FAULT
@ COMMS_FAULT
Definition: commands_base.hpp:93
mip::commands_base::BaseDeviceInfo::firmware_version
uint16_t firmware_version
Parameters.
Definition: commands_base.hpp:62
mip::commands_base::Resume
Definition: commands_base.hpp:472
mip::commands_base::GetDeviceInfo::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:276
mip::commands_base::defaultCommSpeed
TypedResult< CommSpeed > defaultCommSpeed(C::mip_interface &device, uint8_t port)
Definition: commands_base.cpp:410
mip::commands_base::CommandedTestBitsGq7
Definition: commands_base.hpp:79
mip::commands_base::ContinuousBit::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:584
mip::commands_base::CommandedTestBitsGq7::operator=
CommandedTestBitsGq7 & operator=(int val)
Definition: commands_base.hpp:120
mip::commands_base::GetExtendedDescriptors::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:519
mip::commands_base::CommSpeed::port
uint8_t port
Port ID number, starting with 1. When function is SAVE, LOAD, or DEFAULT, this can be 0 to apply to a...
Definition: commands_base.hpp:658
mip
A collection of C++ classes and functions covering the full mip api.
Definition: commands_3dm.c:11
mip::commands_base::CommandedTestBitsGq7::imuAccelFault
bool imuAccelFault() const
Definition: commands_base.hpp:142
mip::commands_base::GpsTimeUpdate::asTuple
auto asTuple()
Definition: commands_base.hpp:764
mip::commands_base::CommandedTestBitsGq7::GNSS_ANTENNA1_FAULT
@ GNSS_ANTENNA1_FAULT
Definition: commands_base.hpp:105
mip::commands_base::CommandedTestBitsGq7::Type
uint32_t Type
Definition: commands_base.hpp:81
mip::commands_base::GpsTimeUpdate::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:434
mip::commands_base::Resume::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:213
mip::commands_base::GetExtendedDescriptors::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:518
mip::commands_base::GpsTimeUpdate::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:756
mip::commands_base::SetIdle
Definition: commands_base.hpp:236
mip::commands_base::CommandedTestBitsGq7::gnssAntenna1Fault
void gnssAntenna1Fault(bool val)
Definition: commands_base.hpp:165
mip::commands_base::BuiltInTest::asTuple
auto asTuple() const
Definition: commands_base.hpp:417
mip::commands_base::GetDeviceInfo::Response::device_info
BaseDeviceInfo device_info
Parameters.
Definition: commands_base.hpp:299
mip::commands_base::GetExtendedDescriptors::Response::asTuple
auto asTuple()
Definition: commands_base.hpp:554
mip::commands_base::GetDeviceDescriptors::asTuple
auto asTuple() const
Definition: commands_base.hpp:348
mip::commands_base::CommandedTestBitsGq7::IMU_MAG_FAULT
@ IMU_MAG_FAULT
Definition: commands_base.hpp:96
mip::commands_base::GetDeviceDescriptors::Response::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:144
mip_descriptors.hpp
mip::commands_base::GetExtendedDescriptors::Response::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:543
mip::commands_base::CMD_GET_EXTENDED_DESCRIPTORS
@ CMD_GET_EXTENDED_DESCRIPTORS
Definition: commands_base.hpp:39
mip::commands_base::GpsTimeUpdate::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:757
mip::commands_base::SetIdle::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:241
mip::commands_base::ContinuousBit::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:582
mip::commands_base::GpsTimeUpdate::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:422
mip::commands_base::GpsTimeUpdate::function
FunctionSelector function
Parameters.
Definition: commands_base.hpp:747
mip::commands_base::Ping::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:204
mip::commands_base::CommandedTestBitsGq7::IMU_ACCEL_FAULT
@ IMU_ACCEL_FAULT
Definition: commands_base.hpp:94
mip::commands_base::CommandedTestBitsGq7::filtReserved
void filtReserved(uint32_t val)
Definition: commands_base.hpp:157
mip::commands_base::CommandedTestBitsGq7::imuPressFault
bool imuPressFault() const
Definition: commands_base.hpp:148
mip::commands_base::GetExtendedDescriptors::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:226
mip::commands_base::CommSpeed::Response::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:330
mip::commands_base::ContinuousBit::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:585
microstrain::Serializer
Serializes or deserializes data to/from a byte buffer.
Definition: serializer.hpp:125
mip::commands_base::Ping
Definition: commands_base.hpp:196
mip::commands_base::GetDeviceInfo::Response::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:307
mip::commands_base::getDeviceInfo
TypedResult< GetDeviceInfo > getDeviceInfo(C::mip_interface &device, BaseDeviceInfo *deviceInfoOut)
Definition: commands_base.cpp:110
mip::commands_base::CommandedTestBitsGq7::imuMagFault
bool imuMagFault() const
Definition: commands_base.hpp:146
mip::commands_base::Ping::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:201
mip::commands_base::CMD_COMM_SPEED
@ CMD_COMM_SPEED
Definition: commands_base.hpp:41
mip::commands_base::SoftReset::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:801
mip::commands_base::loadCommSpeed
TypedResult< CommSpeed > loadCommSpeed(C::mip_interface &device, uint8_t port)
Definition: commands_base.cpp:398
mip::commands_base::SoftReset::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:799
mip::commands_base::BaseDeviceInfo::serial_number
char serial_number[16]
Definition: commands_base.hpp:65
mip::commands_base::CommandedTestBitsGq7::generalHardwareFault
bool generalHardwareFault() const
Definition: commands_base.hpp:124
mip::commands_base::SetIdle::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:239
mip::commands_base::ContinuousBit::Response::asTuple
auto asTuple()
Definition: commands_base.hpp:619
mip::commands_base::CommandedTestBitsGq7::CommandedTestBitsGq7
CommandedTestBitsGq7(int val)
Definition: commands_base.hpp:117
mip::commands_base::GetDeviceDescriptors::Response::asTuple
auto asTuple()
Definition: commands_base.hpp:381
mip::commands_base::CommandedTestBitsGq7::IPC_NAV_FAULT
@ IPC_NAV_FAULT
Definition: commands_base.hpp:91
mip::commands_base::CommandedTestBitsGq7::bufferOverrun
bool bufferOverrun() const
Definition: commands_base.hpp:130
mip::commands_base::CommandedTestBitsGq7::commsFault
bool commsFault() const
Definition: commands_base.hpp:140
mip::commands_base::GetDeviceInfo::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:280
mip::commands_base::GpsTimeUpdate::FieldId
FieldId
Definition: commands_base.hpp:740
mip::commands_base::Resume::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:476
mip::commands_base::CommandedTestBitsGq7::reserved
void reserved(uint32_t val)
Definition: commands_base.hpp:133
mip::commands_base::GetExtendedDescriptors
Definition: commands_base.hpp:511
mip::commands_base::CommSpeed::asTuple
auto asTuple() const
Definition: commands_base.hpp:669
mip::commands_base::CommandedTestBitsGq7::operator=
CommandedTestBitsGq7 & operator=(uint32_t val)
Definition: commands_base.hpp:119
mip::commands_base::CommSpeed::Response::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:699
mip::commands_base::CommSpeed::Response
Definition: commands_base.hpp:691
mip::commands_base::CommSpeed::Response::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:700
mip::commands_base::GpsTimeUpdate::Response
void Response
Definition: commands_base.hpp:780
mip::commands_base::BuiltInTest::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:174
mip::commands_base::CommandedTestBitsGq7::timingOverload
void timingOverload(bool val)
Definition: commands_base.hpp:129
mip::commands_base::CommandedTestBitsGq7::imuReserved
uint32_t imuReserved() const
Definition: commands_base.hpp:150
mip::commands_base::ContinuousBit::Response::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:612
mip::commands_base::GetExtendedDescriptors::Response::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:231
mip::commands_base::Resume::asTuple
auto asTuple() const
Definition: commands_base.hpp:482
mip::commands_base::GetDeviceInfo::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:278
mip::commands_base::GetExtendedDescriptors::Response
Definition: commands_base.hpp:535
mip::commands_base::CommandedTestBitsGq7::IMU_CAL_ERROR
@ IMU_CAL_ERROR
Definition: commands_base.hpp:99
mip::commands_base::CommSpeed::Response::asTuple
auto asTuple() const
Definition: commands_base.hpp:705
mip::commands_base::GetExtendedDescriptors::Response::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:546
mip::commands_base::SoftReset::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:798
mip::commands_base::SetIdle::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:77
mip::commands_base::CommandedTestBitsGq7::operator&=
CommandedTestBitsGq7 & operator&=(uint32_t val)
Definition: commands_base.hpp:122
mip::commands_base::GetDeviceInfo::Response::asTuple
auto asTuple()
Definition: commands_base.hpp:314
mip::commands_base::CommSpeed::baud
uint32_t baud
Port baud rate. Must be a supported rate.
Definition: commands_base.hpp:659
mip::commands_base::GetDeviceDescriptors::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:342
mip::commands_base::BuiltInTest::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:413
mip::commands_base::CommandedTestBitsGq7::setAll
void setAll()
Definition: commands_base.hpp:179
mip::commands_base::GpsTimeUpdate::FieldId::TIME_OF_WEEK
@ TIME_OF_WEEK
Time of week in seconds.
mip::commands_base::BuiltInTest::Response::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:184
mip::commands_base::BuiltInTest::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:411
mip::commands_base::GetDeviceInfo::Response::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:304
mip::commands_base::GpsTimeUpdate::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:752
mip::commands_base::GetDeviceDescriptors::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:345
mip::commands_base::GetDeviceDescriptors::Response::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:373
mip::commands_base::CommandedTestBitsGq7::filtReserved
uint32_t filtReserved() const
Definition: commands_base.hpp:156
mip::commands_base::CommandedTestBitsGq7::IMU_GENERAL_FAULT
@ IMU_GENERAL_FAULT
Definition: commands_base.hpp:100
mip::commands_base::SetIdle::asTuple
auto asTuple() const
Definition: commands_base.hpp:246
mip::commands_base::ContinuousBit::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:581
mip::commands_base::CMD_GET_DEVICE_DESCRIPTORS
@ CMD_GET_DEVICE_DESCRIPTORS
Definition: commands_base.hpp:36
mip::C::mip_interface
struct mip::C::mip_interface mip_interface
State of the interface for communicating with a MIP device.
mip::commands_base::SoftReset
Definition: commands_base.hpp:794
mip::commands_base::GetExtendedDescriptors::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:515
mip::commands_base::BaseDeviceInfo::device_options
char device_options[16]
Definition: commands_base.hpp:67
mip::commands_base::CommSpeed::Response::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:698
mip::commands_base::GpsTimeUpdate
Definition: commands_base.hpp:738
mip::commands_base::GetDeviceInfo::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:275
mip::commands_base::CommandedTestBitsGq7::CommandedTestBitsGq7
CommandedTestBitsGq7()
Definition: commands_base.hpp:116
mip::commands_base::CommandedTestBitsGq7::IMU_RESERVED
@ IMU_RESERVED
Definition: commands_base.hpp:98
mip::commands_base::CommandedTestBitsGq7::TIMING_OVERLOAD
@ TIMING_OVERLOAD
Definition: commands_base.hpp:87
mip::commands_base::CommSpeed::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:665
mip::commands_base::CommandedTestBitsGq7::filtSolutionFault
bool filtSolutionFault() const
Definition: commands_base.hpp:158
mip::commands_base::GetDeviceDescriptors::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:346
mip::commands_base::BuiltInTest::Response::asTuple
auto asTuple() const
Definition: commands_base.hpp:444
mip::commands_base::SetIdle::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:81
mip::commands_base::CommandedTestBitsGq7::FILT_GENERAL_FAULT
@ FILT_GENERAL_FAULT
Definition: commands_base.hpp:103
mip::commands_base::GetDeviceInfo::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:94
mip::commands_base::CommandedTestBitsGq7::ipcNavFault
void ipcNavFault(bool val)
Definition: commands_base.hpp:137
mip::commands_base::BuiltInTest::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:410
mip::commands_base::GetDeviceInfo::asTuple
auto asTuple()
Definition: commands_base.hpp:287
mip::commands_base::SetIdle::Response
void Response
Definition: commands_base.hpp:260
mip::commands_base::CommandedTestBitsGq7::imuReserved
void imuReserved(uint32_t val)
Definition: commands_base.hpp:151
mip::commands_base::GetExtendedDescriptors::Response::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:542
mip::commands_base::GetDeviceDescriptors::Response::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:372
mip::commands_base::GetDeviceDescriptors::Response::descriptors_count
uint8_t descriptors_count
Definition: commands_base.hpp:366
mip::commands_base::CommSpeed::Response::asTuple
auto asTuple()
Definition: commands_base.hpp:710
mip::commands_base::CommandedTestBitsGq7::imuGeneralFault
void imuGeneralFault(bool val)
Definition: commands_base.hpp:155
mip::commands_base::continuousBit
TypedResult< ContinuousBit > continuousBit(C::mip_interface &device, uint8_t *resultOut)
Definition: commands_base.cpp:285
mip::commands_base::SetIdle::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:240
mip::commands_base::CommSpeed::Response::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:701
mip::commands_base::CMD_SOFT_RESET
@ CMD_SOFT_RESET
Definition: commands_base.hpp:43
mip::commands_base::CommSpeed::create_sld_all
static CommSpeed create_sld_all(::mip::FunctionSelector function)
Definition: commands_base.hpp:679
mip::commands_base::GetDeviceInfo::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:90
mip::commands_base::CommandedTestBitsGq7::imuGyroFault
bool imuGyroFault() const
Definition: commands_base.hpp:144
mip::commands_base::CommandedTestBitsGq7::imuPressFault
void imuPressFault(bool val)
Definition: commands_base.hpp:149
mip::commands_base::ContinuousBit::Response::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:610
mip::commands_base::GetExtendedDescriptors::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:222
mip::commands_base::CommandedTestBitsGq7::GNSS_ANTENNA2_FAULT
@ GNSS_ANTENNA2_FAULT
Definition: commands_base.hpp:107
mip::commands_base::CommandedTestBitsGq7::gnssSolutionFault
bool gnssSolutionFault() const
Definition: commands_base.hpp:174
mip::commands_base::BaseDeviceInfo::model_name
char model_name[16]
Definition: commands_base.hpp:63
mip::commands_base::CommSpeed::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:667
mip::commands_base::CommandedTestBitsGq7::value
uint32_t value
Definition: commands_base.hpp:114
mip::commands_base::GetDeviceInfo::Response::asTuple
auto asTuple() const
Definition: commands_base.hpp:309
mip::commands_base::GpsTimeUpdate::value
uint32_t value
Week number or time of week, depending on the field_id.
Definition: commands_base.hpp:749
mip::commands_base::BaseDeviceInfo::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:23
mip::commands_base::Resume::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:480
mip::commands_base::REPLY_DEVICE_INFO
@ REPLY_DEVICE_INFO
Definition: commands_base.hpp:45
mip::commands_base::GetDeviceDescriptors::Response::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:371
mip::commands_base::CommandedTestBitsGq7::gnssRtkFault
bool gnssRtkFault() const
Definition: commands_base.hpp:172
mip::commands_base::CommandedTestBitsGq7::NONE
@ NONE
Definition: commands_base.hpp:84
mip::commands_base::BuiltInTest::Response::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:441
mip::commands_base::ContinuousBit::Response::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:272
mip::commands_base::ContinuousBit::Response::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:609
mip::commands_base::GetDeviceInfo
Definition: commands_base.hpp:272
mip::commands_base::GpsTimeUpdate::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:753
mip::commands_base::GetDeviceDescriptors::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:341
mip::commands_base::ContinuousBit::Response::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:278
mip::commands_base::GetExtendedDescriptors::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:517
mip::FunctionSelector
FunctionSelector
Definition: mip_descriptors.hpp:66
mip::commands_base::SetIdle::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:244
mip::commands_base::GetDeviceInfo::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:279
mip::commands_base::getExtendedDescriptors
TypedResult< GetExtendedDescriptors > getExtendedDescriptors(C::mip_interface &device, uint16_t *descriptorsOut, size_t descriptorsOutMax, uint8_t *descriptorsOutCount)
Definition: commands_base.cpp:244
mip::commands_base::GetDeviceInfo::Response::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:99
mip::commands_base::BaseDeviceInfo::lot_number
char lot_number[16]
Definition: commands_base.hpp:66
mip::commands_base::CommandedTestBitsGq7::gnssReceiver1Fault
bool gnssReceiver1Fault() const
Definition: commands_base.hpp:162
mip::commands_base::CommandedTestBitsGq7::GNSS_RECEIVER2_FAULT
@ GNSS_RECEIVER2_FAULT
Definition: commands_base.hpp:106
mip::commands_base::ContinuousBit::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:583
mip::commands_base::CommandedTestBitsGq7::filtSolutionFault
void filtSolutionFault(bool val)
Definition: commands_base.hpp:159
mip::commands_base::GetExtendedDescriptors::asTuple
auto asTuple()
Definition: commands_base.hpp:526
mip::commands_base::CommandedTestBitsGq7::imuCalError
bool imuCalError() const
Definition: commands_base.hpp:152
mip::commands_base::CommandedTestBitsGq7::generalHardwareFault
void generalHardwareFault(bool val)
Definition: commands_base.hpp:125
mip::commands_base::SoftReset::asTuple
auto asTuple()
Definition: commands_base.hpp:809
mip::commands_base::BuiltInTest::Response::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:438
mip::commands_base::REPLY_CONTINUOUS_BIT
@ REPLY_CONTINUOUS_BIT
Definition: commands_base.hpp:51
mip::commands_base::ContinuousBit::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:580
mip::commands_base::BuiltInTest::Response::asTuple
auto asTuple()
Definition: commands_base.hpp:449
mip::commands_base::CommandedTestBitsGq7::gnssReceiver2Fault
void gnssReceiver2Fault(bool val)
Definition: commands_base.hpp:167
mip::commands_base::CommSpeed::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:305
mip::commands_base::ContinuousBit::Response
Definition: commands_base.hpp:601
mip::commands_base::CommandedTestBitsGq7::commsFault
void commsFault(bool val)
Definition: commands_base.hpp:141
mip::commands_base::CommandedTestBitsGq7::reserved
uint32_t reserved() const
Definition: commands_base.hpp:132
mip::commands_base::BuiltInTest::asTuple
auto asTuple()
Definition: commands_base.hpp:422
mip::commands_base::CommSpeed::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:664
mip::commands_base::CommSpeed::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:663
mip::commands_base::CommandedTestBitsGq7::generalFirmwareFault
bool generalFirmwareFault() const
Definition: commands_base.hpp:126
mip::commands_base::ping
TypedResult< Ping > ping(C::mip_interface &device)
Definition: commands_base.cpp:73
mip::commands_base::BaseDeviceInfo
Definition: commands_base.hpp:59
mip::commands_base::CommSpeed::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:662
mip::commands_base::CommandedTestBitsGq7::imuGeneralFault
bool imuGeneralFault() const
Definition: commands_base.hpp:154
mip::commands_base::REPLY_DEVICE_DESCRIPTORS
@ REPLY_DEVICE_DESCRIPTORS
Definition: commands_base.hpp:46
mip::commands_base::CommandedTestBitsGq7::operator|=
CommandedTestBitsGq7 & operator|=(uint32_t val)
Definition: commands_base.hpp:121
mip::commands_base::CommSpeed::ALL_PORTS
static constexpr const uint32_t ALL_PORTS
Definition: commands_base.hpp:655
mip::commands_base::Ping::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:199
mip::commands_base::SoftReset::Response
void Response
Definition: commands_base.hpp:818
mip::commands_base::REPLY_COMM_SPEED
@ REPLY_COMM_SPEED
Definition: commands_base.hpp:52
mip::commands_base::CommandedTestBitsGq7::filtGeneralFault
bool filtGeneralFault() const
Definition: commands_base.hpp:160
mip::commands_base::BaseDeviceInfo::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:43
mip::commands_base::CommSpeed::Response::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:702
mip::commands_base::BuiltInTest
Definition: commands_base.hpp:407
mip::commands_base::CommandedTestBitsGq7::filtGeneralFault
void filtGeneralFault(bool val)
Definition: commands_base.hpp:161
mip::commands_base::GpsTimeUpdate::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:755
mip::commands_base::CommandedTestBitsGq7::ipcNavFault
bool ipcNavFault() const
Definition: commands_base.hpp:136
mip::commands_base::CommSpeed::Response::baud
uint32_t baud
Port baud rate. Must be a supported rate.
Definition: commands_base.hpp:695
mip::commands_base::GetExtendedDescriptors::Response::descriptors_count
uint8_t descriptors_count
Definition: commands_base.hpp:539
mip::commands_base::ContinuousBit
Definition: commands_base.hpp:577
mip::commands_base::CommandedTestBitsGq7::gnssRtcmFailure
bool gnssRtcmFailure() const
Definition: commands_base.hpp:170
mip::commands_base::ContinuousBit::Response::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:607
mip::commands_base::writeCommSpeed
TypedResult< CommSpeed > writeCommSpeed(C::mip_interface &device, uint8_t port, uint32_t baud)
Definition: commands_base.cpp:345
mip::commands_base::CommandedTestBitsGq7::ipcGnssFault
void ipcGnssFault(bool val)
Definition: commands_base.hpp:139
mip::commands_base::Ping::Response
void Response
Definition: commands_base.hpp:220
mip::commands_base::CommandedTestBitsGq7::timingOverload
bool timingOverload() const
Definition: commands_base.hpp:128
mip::commands_base::CMD_SET_TO_IDLE
@ CMD_SET_TO_IDLE
Definition: commands_base.hpp:34
mip::commands_base::CMD_BUILT_IN_TEST
@ CMD_BUILT_IN_TEST
Definition: commands_base.hpp:37
mip::commands_base::GetDeviceInfo::Response::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:305
mip::commands_base::CommandedTestBitsGq7::gnssAntenna2Fault
bool gnssAntenna2Fault() const
Definition: commands_base.hpp:168
mip::commands_base::GetDeviceInfo::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:277
mip::commands_base::CommSpeed::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:666
mip::commands_base::CommandedTestBitsGq7::GNSS_RTCM_FAILURE
@ GNSS_RTCM_FAILURE
Definition: commands_base.hpp:108
mip::commands_base::ContinuousBit::asTuple
auto asTuple()
Definition: commands_base.hpp:592
mip::C::mip_interface
State of the interface for communicating with a MIP device.
Definition: mip_interface.h:44
mip::commands_base::CommandedTestBitsGq7::gnssRtkFault
void gnssRtkFault(bool val)
Definition: commands_base.hpp:173
mip::commands_base::CommSpeed::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:317
mip::commands_base::Ping::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:202
mip::commands_base::CommandedTestBitsGq7::imuGyroFault
void imuGyroFault(bool val)
Definition: commands_base.hpp:145
mip::commands_base::CommandedTestBitsGq7::bufferOverrun
void bufferOverrun(bool val)
Definition: commands_base.hpp:131
mip::commands_base::Resume::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:209
mip::commands_base::BuiltInTest::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:415
mip::commands_base::Ping::asTuple
auto asTuple()
Definition: commands_base.hpp:211
mip::commands_base::CommandedTestBitsGq7::imuAccelFault
void imuAccelFault(bool val)
Definition: commands_base.hpp:143
mip::commands_base::CMD_GET_DEVICE_INFO
@ CMD_GET_DEVICE_INFO
Definition: commands_base.hpp:35
mip::commands_base::Resume::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:477
mip::commands_base::CommandedTestBitsGq7::allSet
bool allSet() const
Definition: commands_base.hpp:178
mip::commands_base::CommandedTestBitsGq7::GNSS_RECEIVER1_FAULT
@ GNSS_RECEIVER1_FAULT
Definition: commands_base.hpp:104
mip::commands_base::CommandedTestBitsGq7::IMU_PRESS_FAULT
@ IMU_PRESS_FAULT
Definition: commands_base.hpp:97
mip::commands_base::CommandedTestBitsGq7::_enumType
_enumType
Definition: commands_base.hpp:82
mip::commands_base::GpsTimeUpdate::field_id
FieldId field_id
Determines how to interpret value.
Definition: commands_base.hpp:748
mip::commands_base::CommandedTestBitsGq7::gnssRtcmFailure
void gnssRtcmFailure(bool val)
Definition: commands_base.hpp:171
mip::commands_base::Resume::Response
void Response
Definition: commands_base.hpp:496
mip::commands_base::GetDeviceInfo::Response::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:303
mip::commands_base::GetDeviceDescriptors::Response::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:370
mip::commands_base::Ping::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:64
mip::commands_base::GetDeviceDescriptors::Response::descriptors
uint16_t descriptors[253]
Parameters.
Definition: commands_base.hpp:365
mip::commands_base::SoftReset::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:797
mip::commands_base::CommandedTestBitsGq7::generalFirmwareFault
void generalFirmwareFault(bool val)
Definition: commands_base.hpp:127
mip::commands_base::GpsTimeUpdate::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:754
mip::commands_base::CommandedTestBitsGq7::GNSS_RTK_FAULT
@ GNSS_RTK_FAULT
Definition: commands_base.hpp:109
mip::commands_base::CommandedTestBitsGq7::GNSS_SOLUTION_FAULT
@ GNSS_SOLUTION_FAULT
Definition: commands_base.hpp:110
mip::commands_base::ContinuousBit::Response::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:611
mip_interface.hpp
mip::commands_base::setIdle
TypedResult< SetIdle > setIdle(C::mip_interface &device)
Definition: commands_base.cpp:86
mip::commands_base::BuiltInTest::Response::result
uint32_t result
Parameters.
Definition: commands_base.hpp:434
mip::commands_base::GetDeviceInfo::Response::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:306
mip::commands_base::BuiltInTest::Response::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:179
mip::commands_base::GetDeviceInfo::asTuple
auto asTuple() const
Definition: commands_base.hpp:282
mip::commands_base::CommSpeed::Response::port
uint8_t port
Parameters.
Definition: commands_base.hpp:694
mip::commands_base::CommandedTestBitsGq7::IPC_IMU_FAULT
@ IPC_IMU_FAULT
Definition: commands_base.hpp:90
mip::commands_base::Ping::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:68
mip::commands_base::CommSpeed::Response::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:703
mip::commands_base::resume
TypedResult< Resume > resume(C::mip_interface &device)
Definition: commands_base.cpp:218
mip::commands_base::BuiltInTest::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:414
mip::commands_base::Resume::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:478
mip::commands_base::CommandedTestBitsGq7::imuCalError
void imuCalError(bool val)
Definition: commands_base.hpp:153
mip::commands_base::GpsTimeUpdate::create_sld_all
static GpsTimeUpdate create_sld_all(::mip::FunctionSelector function)
Definition: commands_base.hpp:769
mip::commands_base::SetIdle::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:242
mip::commands_base::CMD_PING
@ CMD_PING
Definition: commands_base.hpp:33
mip::commands_base::Ping::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:200
mip::commands_base::CommandedTestBitsGq7::imuMagFault
void imuMagFault(bool val)
Definition: commands_base.hpp:147
mip::commands_base::ContinuousBit::Response::asTuple
auto asTuple() const
Definition: commands_base.hpp:614
mip::commands_base::REPLY_GET_EXTENDED_DESCRIPTORS
@ REPLY_GET_EXTENDED_DESCRIPTORS
Definition: commands_base.hpp:50
mip::commands_base::CommSpeed::asTuple
auto asTuple()
Definition: commands_base.hpp:674
mip::commands_base::CommandedTestBitsGq7::FILT_RESERVED
@ FILT_RESERVED
Definition: commands_base.hpp:101
mip::commands_base::GpsTimeUpdate::asTuple
auto asTuple() const
Definition: commands_base.hpp:759
mip::commands_base::CommandedTestBitsGq7::gnssGeneralFault
bool gnssGeneralFault() const
Definition: commands_base.hpp:176
mip::commands_base::CommandedTestBitsGq7::IMU_GYRO_FAULT
@ IMU_GYRO_FAULT
Definition: commands_base.hpp:95
mip::commands_base::GetExtendedDescriptors::Response::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:545
mip::commands_base::GetDeviceDescriptors::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:129
mip::commands_base::CommandedTestBitsGq7::gnssAntenna2Fault
void gnssAntenna2Fault(bool val)
Definition: commands_base.hpp:169
mip::commands_base::SetIdle::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:243
mip::commands_base::SoftReset::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:800
mip::commands_base::BuiltInTest::Response::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:442
mip::commands_base::GetExtendedDescriptors::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:514
mip::commands_base::GetExtendedDescriptors::Response::asTuple
auto asTuple() const
Definition: commands_base.hpp:549
mip::commands_base::CommandedTestBitsGq7::GENERAL_FIRMWARE_FAULT
@ GENERAL_FIRMWARE_FAULT
Definition: commands_base.hpp:86
mip::commands_base::Ping::asTuple
auto asTuple() const
Definition: commands_base.hpp:206
mip::commands_base::Resume::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:479
mip::commands_base::BuiltInTest::Response::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:440
mip::commands_base::SoftReset::asTuple
auto asTuple() const
Definition: commands_base.hpp:804
mip::commands_base::CommSpeed::function
FunctionSelector function
Parameters.
Definition: commands_base.hpp:657
mip::commands_base::REPLY_GPS_CORRELATION_WEEK
@ REPLY_GPS_CORRELATION_WEEK
Definition: commands_base.hpp:48
mip::commands_base::GetDeviceDescriptors
Definition: commands_base.hpp:338
mip::commands_base::CommandedTestBitsGq7::gnssSolutionFault
void gnssSolutionFault(bool val)
Definition: commands_base.hpp:175
mip::commands_base::CommSpeed::Response::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:337
mip::commands_base::ContinuousBit::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:267
mip::commands_base::GetExtendedDescriptors::Response::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:547
mip::commands_base::BuiltInTest::Response
Definition: commands_base.hpp:431
mip::commands_base::REPLY_BUILT_IN_TEST
@ REPLY_BUILT_IN_TEST
Definition: commands_base.hpp:47
mip::commands_base::SoftReset::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:802
mip::commands_base::BuiltInTest::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:412
mip::commands_base::ContinuousBit::asTuple
auto asTuple() const
Definition: commands_base.hpp:587
mip::commands_base::CommandedTestBitsGq7::BUFFER_OVERRUN
@ BUFFER_OVERRUN
Definition: commands_base.hpp:88
mip::commands_base::CMD_RESUME
@ CMD_RESUME
Definition: commands_base.hpp:38
mip::commands_base::GetDeviceDescriptors::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:133
mip::commands_base::CommandedTestBitsGq7::FILT_SOLUTION_FAULT
@ FILT_SOLUTION_FAULT
Definition: commands_base.hpp:102
mip::commands_base::GpsTimeUpdate::FieldId::WEEK_NUMBER
@ WEEK_NUMBER
Week number.
mip::commands_base::CommandedTestBitsGq7::gnssAntenna1Fault
bool gnssAntenna1Fault() const
Definition: commands_base.hpp:164
mip::commands_base::GetDeviceDescriptors::Response
Definition: commands_base.hpp:362
mip::CompositeDescriptor
Convenience struct holding both descriptor set and field descriptor.
Definition: mip_descriptors.hpp:21
mip::commands_base::TimeFormat::GPS
@ GPS
GPS time, a = week number since 1980, b = time of week in milliseconds.
mip::commands_base::ContinuousBit::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:263
mip::commands_base::builtInTest
TypedResult< BuiltInTest > builtInTest(C::mip_interface &device, uint32_t *resultOut)
Definition: commands_base.cpp:190
mip::commands_base::writeGpsTimeUpdate
TypedResult< GpsTimeUpdate > writeGpsTimeUpdate(C::mip_interface &device, GpsTimeUpdate::FieldId fieldId, uint32_t value)
Definition: commands_base.cpp:447
mip::commands_base::BuiltInTest::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:170
mip::commands_base::GetDeviceDescriptors::Response::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:138
mip::commands_base::GetDeviceDescriptors::NAME
static constexpr const char * NAME
Definition: commands_base.hpp:344
mip::commands_base::ContinuousBit::Response::result
uint8_t result[16]
Parameters.
Definition: commands_base.hpp:604
mip::commands_base::DESCRIPTOR_SET
@ DESCRIPTOR_SET
Definition: commands_base.hpp:31
mip::commands_base::CommandedTestBitsGq7::IPC_GNSS_FAULT
@ IPC_GNSS_FAULT
Definition: commands_base.hpp:92
mip::commands_base::GetExtendedDescriptors::Response::descriptors
uint16_t descriptors[253]
Parameters.
Definition: commands_base.hpp:538
mip::commands_base::BuiltInTest::Response::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:439
mip::commands_base::CommandedTestBitsGq7::ipcImuFault
void ipcImuFault(bool val)
Definition: commands_base.hpp:135
mip::commands_base::CommandedTestBitsGq7::GENERAL_HARDWARE_FAULT
@ GENERAL_HARDWARE_FAULT
Definition: commands_base.hpp:85
mip::commands_base::Resume::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:475
mip::commands_base::SoftReset::insert
void insert(Serializer &serializer) const
Serialization.
Definition: commands_base.cpp:461
mip::commands_base::readCommSpeed
TypedResult< CommSpeed > readCommSpeed(C::mip_interface &device, uint8_t port, uint32_t *baudOut)
Definition: commands_base.cpp:359
mip::commands_base::BaseDeviceInfo::model_number
char model_number[16]
Definition: commands_base.hpp:64
mip::commands_base::GetExtendedDescriptors::asTuple
auto asTuple() const
Definition: commands_base.hpp:521
mip::commands_base::SetIdle::asTuple
auto asTuple()
Definition: commands_base.hpp:251
mip::commands_base::GetDeviceDescriptors::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:343
mip::commands_base::GetExtendedDescriptors::Response::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:544
mip::commands_base::CommandedTestBitsGq7::RESERVED
@ RESERVED
Definition: commands_base.hpp:89
mip::commands_base::GetDeviceInfo::Response::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:302
mip::commands_base::CommandedTestBitsGq7::ipcImuFault
bool ipcImuFault() const
Definition: commands_base.hpp:134
mip::Bitfield
A dummy struct which is used to mark bitfield objects.
Definition: mip_descriptors.hpp:61
mip::commands_base::saveCommSpeed
TypedResult< CommSpeed > saveCommSpeed(C::mip_interface &device, uint8_t port)
Definition: commands_base.cpp:386
mip::commands_base::CommandedTestBitsGq7::ipcGnssFault
bool ipcGnssFault() const
Definition: commands_base.hpp:138
mip::commands_base::GetDeviceInfo::Response
Definition: commands_base.hpp:296
mip::commands_base::Ping::DOC_NAME
static constexpr const char * DOC_NAME
Definition: commands_base.hpp:203
mip::commands_base::SoftReset::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:465
mip::commands_base::CMD_GPS_TIME_UPDATE
@ CMD_GPS_TIME_UPDATE
Definition: commands_base.hpp:42
mip::commands_base::CMD_CONTINUOUS_BIT
@ CMD_CONTINUOUS_BIT
Definition: commands_base.hpp:40
mip::commands_base::GetDeviceDescriptors::Response::HAS_FUNCTION_SELECTOR
static constexpr const bool HAS_FUNCTION_SELECTOR
Definition: commands_base.hpp:374
mip::commands_base::GetDeviceInfo::Response::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:104
mip::TypedResult
A CmdResult that knows the corresponding command type.
Definition: mip_descriptors.hpp:97
mip::commands_base::CommandedTestBitsGq7::gnssReceiver2Fault
bool gnssReceiver2Fault() const
Definition: commands_base.hpp:166
mip::commands_base::GetDeviceDescriptors::asTuple
auto asTuple()
Definition: commands_base.hpp:353
mip::commands_base::BuiltInTest::Response::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:437
mip::commands_base::CommandedTestBitsGq7::gnssGeneralFault
void gnssGeneralFault(bool val)
Definition: commands_base.hpp:177
mip::commands_base::CommandedTestBitsGq7::ALL
@ ALL
Definition: commands_base.hpp:112
common.hpp
mip_result.hpp
mip::commands_base::GetExtendedDescriptors::DESCRIPTOR
static constexpr const CompositeDescriptor DESCRIPTOR
Definition: commands_base.hpp:516
mip::commands_base::GetDeviceDescriptors::Response::DESCRIPTOR_SET
static constexpr const uint8_t DESCRIPTOR_SET
Descriptors.
Definition: commands_base.hpp:369
mip::commands_base::CommSpeed
Definition: commands_base.hpp:653
mip::commands_base::GetExtendedDescriptors::Response::extract
void extract(Serializer &serializer)
Definition: commands_base.cpp:237
mip::commands_base::ContinuousBit::Response::FIELD_DESCRIPTOR
static constexpr const uint8_t FIELD_DESCRIPTOR
Definition: commands_base.hpp:608
mip::commands_base::GetDeviceDescriptors::Response::asTuple
auto asTuple() const
Definition: commands_base.hpp:376
mip::commands_base::Resume::asTuple
auto asTuple()
Definition: commands_base.hpp:487
mip::commands_base::TimeFormat
TimeFormat
Definition: commands_base.hpp:74
mip::commands_base::CommandedTestBitsGq7::GNSS_GENERAL_FAULT
@ GNSS_GENERAL_FAULT
Definition: commands_base.hpp:111