MIP_SDK  v3.0.0
MicroStrain Communications Library for embedded systems
Classes | Namespaces | Typedefs | Enumerations | Functions
commands_rtk.h File Reference
#include <mip/definitions/common.h>
#include <mip/mip_descriptors.h>
#include <mip/mip_result.h>
#include <mip/mip_interface.h>
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>

Go to the source code of this file.

Classes

struct  mip::C::mip_rtk_get_status_flags_response
 
struct  mip::C::mip_rtk_get_imei_response
 
struct  mip::C::mip_rtk_get_imsi_response
 
struct  mip::C::mip_rtk_get_iccid_response
 
struct  mip::C::mip_rtk_connected_device_type_command
 
struct  mip::C::mip_rtk_connected_device_type_response
 
struct  mip::C::mip_rtk_get_act_code_response
 
struct  mip::C::mip_rtk_get_modem_firmware_version_response
 
struct  mip::C::mip_rtk_get_rssi_response
 
struct  mip::C::mip_rtk_service_status_command
 
struct  mip::C::mip_rtk_service_status_response
 
struct  mip::C::mip_rtk_prod_erase_storage_command
 
struct  mip::C::mip_rtk_led_control_command
 

Namespaces

 mip
 A collection of C++ classes and functions covering the full mip api.
 
 mip::C
 

Typedefs

typedef enum mip_media_selector mip::C::mip_media_selector
 
typedef enum mip_led_action mip::C::mip_led_action
 
typedef uint32_t mip::C::mip_rtk_get_status_flags_command_status_flags_legacy
 
typedef uint32_t mip::C::mip_rtk_get_status_flags_command_status_flags
 
typedef struct mip_rtk_get_status_flags_command mip::C::mip_rtk_get_status_flags_command
 No parameters (empty struct not allowed in C) More...
 
typedef struct mip_rtk_get_status_flags_response mip::C::mip_rtk_get_status_flags_response
 
typedef struct mip_rtk_get_imei_command mip::C::mip_rtk_get_imei_command
 No parameters (empty struct not allowed in C) More...
 
typedef struct mip_rtk_get_imei_response mip::C::mip_rtk_get_imei_response
 
typedef struct mip_rtk_get_imsi_command mip::C::mip_rtk_get_imsi_command
 No parameters (empty struct not allowed in C) More...
 
typedef struct mip_rtk_get_imsi_response mip::C::mip_rtk_get_imsi_response
 
typedef struct mip_rtk_get_iccid_command mip::C::mip_rtk_get_iccid_command
 No parameters (empty struct not allowed in C) More...
 
typedef struct mip_rtk_get_iccid_response mip::C::mip_rtk_get_iccid_response
 
typedef enum mip_rtk_connected_device_type_command_type mip::C::mip_rtk_connected_device_type_command_type
 
typedef struct mip_rtk_connected_device_type_command mip::C::mip_rtk_connected_device_type_command
 
typedef struct mip_rtk_connected_device_type_response mip::C::mip_rtk_connected_device_type_response
 
typedef struct mip_rtk_get_act_code_command mip::C::mip_rtk_get_act_code_command
 No parameters (empty struct not allowed in C) More...
 
typedef struct mip_rtk_get_act_code_response mip::C::mip_rtk_get_act_code_response
 
typedef struct mip_rtk_get_modem_firmware_version_command mip::C::mip_rtk_get_modem_firmware_version_command
 No parameters (empty struct not allowed in C) More...
 
typedef struct mip_rtk_get_modem_firmware_version_response mip::C::mip_rtk_get_modem_firmware_version_response
 
typedef struct mip_rtk_get_rssi_command mip::C::mip_rtk_get_rssi_command
 No parameters (empty struct not allowed in C) More...
 
typedef struct mip_rtk_get_rssi_response mip::C::mip_rtk_get_rssi_response
 
typedef uint8_t mip::C::mip_rtk_service_status_command_service_flags
 
typedef struct mip_rtk_service_status_command mip::C::mip_rtk_service_status_command
 
typedef struct mip_rtk_service_status_response mip::C::mip_rtk_service_status_response
 
typedef struct mip_rtk_prod_erase_storage_command mip::C::mip_rtk_prod_erase_storage_command
 
typedef struct mip_rtk_led_control_command mip::C::mip_rtk_led_control_command
 
typedef struct mip_rtk_modem_hard_reset_command mip::C::mip_rtk_modem_hard_reset_command
 No parameters (empty struct not allowed in C) More...
 

Enumerations

enum  {
  mip::C::MIP_RTK_CMD_DESC_SET = 0x0F, mip::C::MIP_CMD_DESC_RTK_GET_STATUS_FLAGS = 0x01, mip::C::MIP_CMD_DESC_RTK_GET_IMEI = 0x02, mip::C::MIP_CMD_DESC_RTK_GET_IMSI = 0x03,
  mip::C::MIP_CMD_DESC_RTK_GET_ICCID = 0x04, mip::C::MIP_CMD_DESC_RTK_GET_RSSI = 0x05, mip::C::MIP_CMD_DESC_RTK_CONNECTED_DEVICE_TYPE = 0x06, mip::C::MIP_CMD_DESC_RTK_GET_ACT_CODE = 0x07,
  mip::C::MIP_CMD_DESC_RTK_GET_MODEM_FIRMWARE_VERSION = 0x08, mip::C::MIP_CMD_DESC_RTK_SERVICE_STATUS = 0x0A, mip::C::MIP_CMD_DESC_RTK_PROD_ERASE_STORAGE = 0x20, mip::C::MIP_CMD_DESC_LED_CONTROL = 0x21,
  mip::C::MIP_CMD_DESC_RTK_MODEM_HARD_RESET = 0x22, mip::C::MIP_REPLY_DESC_RTK_GET_STATUS_FLAGS = 0x81, mip::C::MIP_REPLY_DESC_RTK_GET_IMEI = 0x82, mip::C::MIP_REPLY_DESC_RTK_GET_IMSI = 0x83,
  mip::C::MIP_REPLY_DESC_RTK_GET_ICCID = 0x84, mip::C::MIP_REPLY_DESC_RTK_CONNECTED_DEVICE_TYPE = 0x86, mip::C::MIP_REPLY_DESC_RTK_GET_ACT_CODE = 0x87, mip::C::MIP_REPLY_DESC_RTK_GET_MODEM_FIRMWARE_VERSION = 0x88,
  mip::C::MIP_REPLY_DESC_RTK_GET_RSSI = 0x85, mip::C::MIP_REPLY_DESC_RTK_SERVICE_STATUS = 0x8A
}
 
enum  mip::C::mip_media_selector { mip::C::MIP_MEDIA_SELECTOR_MEDIA_EXTERNALFLASH = 0, mip::C::MIP_MEDIA_SELECTOR_MEDIA_SD = 1 }
 
enum  mip::C::mip_led_action { mip::C::MIP_LED_ACTION_LED_NONE = 0, mip::C::MIP_LED_ACTION_LED_FLASH = 1, mip::C::MIP_LED_ACTION_LED_PULSATE = 2 }
 
enum  mip::C::mip_rtk_connected_device_type_command_type { mip::C::MIP_RTK_CONNECTED_DEVICE_TYPE_COMMAND_TYPE_GENERIC = 0, mip::C::MIP_RTK_CONNECTED_DEVICE_TYPE_COMMAND_TYPE_GQ7 = 1 }
 

Functions

void mip::C::insert_mip_rtk_get_status_flags_response (microstrain_serializer *serializer, const mip_rtk_get_status_flags_response *self)
 
void mip::C::extract_mip_rtk_get_status_flags_response (microstrain_serializer *serializer, mip_rtk_get_status_flags_response *self)
 
mip_cmd_result mip::C::mip_rtk_get_status_flags (mip_interface *device, mip_rtk_get_status_flags_command_status_flags *flags_out)
 
void mip::C::insert_mip_rtk_get_imei_response (microstrain_serializer *serializer, const mip_rtk_get_imei_response *self)
 
void mip::C::extract_mip_rtk_get_imei_response (microstrain_serializer *serializer, mip_rtk_get_imei_response *self)
 
mip_cmd_result mip::C::mip_rtk_get_imei (mip_interface *device, char *imei_out)
 
void mip::C::insert_mip_rtk_get_imsi_response (microstrain_serializer *serializer, const mip_rtk_get_imsi_response *self)
 
void mip::C::extract_mip_rtk_get_imsi_response (microstrain_serializer *serializer, mip_rtk_get_imsi_response *self)
 
mip_cmd_result mip::C::mip_rtk_get_imsi (mip_interface *device, char *imsi_out)
 
void mip::C::insert_mip_rtk_get_iccid_response (microstrain_serializer *serializer, const mip_rtk_get_iccid_response *self)
 
void mip::C::extract_mip_rtk_get_iccid_response (microstrain_serializer *serializer, mip_rtk_get_iccid_response *self)
 
mip_cmd_result mip::C::mip_rtk_get_iccid (mip_interface *device, char *iccid_out)
 
void mip::C::insert_mip_rtk_connected_device_type_command (microstrain_serializer *serializer, const mip_rtk_connected_device_type_command *self)
 
void mip::C::extract_mip_rtk_connected_device_type_command (microstrain_serializer *serializer, mip_rtk_connected_device_type_command *self)
 
void mip::C::insert_mip_rtk_connected_device_type_response (microstrain_serializer *serializer, const mip_rtk_connected_device_type_response *self)
 
void mip::C::extract_mip_rtk_connected_device_type_response (microstrain_serializer *serializer, mip_rtk_connected_device_type_response *self)
 
mip_cmd_result mip::C::mip_rtk_write_connected_device_type (mip_interface *device, mip_rtk_connected_device_type_command_type dev_type)
 
mip_cmd_result mip::C::mip_rtk_read_connected_device_type (mip_interface *device, mip_rtk_connected_device_type_command_type *dev_type_out)
 
mip_cmd_result mip::C::mip_rtk_save_connected_device_type (mip_interface *device)
 
mip_cmd_result mip::C::mip_rtk_load_connected_device_type (mip_interface *device)
 
mip_cmd_result mip::C::mip_rtk_default_connected_device_type (mip_interface *device)
 
void mip::C::insert_mip_rtk_get_act_code_response (microstrain_serializer *serializer, const mip_rtk_get_act_code_response *self)
 
void mip::C::extract_mip_rtk_get_act_code_response (microstrain_serializer *serializer, mip_rtk_get_act_code_response *self)
 
mip_cmd_result mip::C::mip_rtk_get_act_code (mip_interface *device, char *activation_code_out)
 
void mip::C::insert_mip_rtk_get_modem_firmware_version_response (microstrain_serializer *serializer, const mip_rtk_get_modem_firmware_version_response *self)
 
void mip::C::extract_mip_rtk_get_modem_firmware_version_response (microstrain_serializer *serializer, mip_rtk_get_modem_firmware_version_response *self)
 
mip_cmd_result mip::C::mip_rtk_get_modem_firmware_version (mip_interface *device, char *modem_firmware_version_out)
 
void mip::C::insert_mip_rtk_get_rssi_response (microstrain_serializer *serializer, const mip_rtk_get_rssi_response *self)
 
void mip::C::extract_mip_rtk_get_rssi_response (microstrain_serializer *serializer, mip_rtk_get_rssi_response *self)
 
mip_cmd_result mip::C::mip_rtk_get_rssi (mip_interface *device, bool *valid_out, int32_t *rssi_out, int32_t *signal_quality_out)
 
void mip::C::insert_mip_rtk_service_status_command (microstrain_serializer *serializer, const mip_rtk_service_status_command *self)
 
void mip::C::extract_mip_rtk_service_status_command (microstrain_serializer *serializer, mip_rtk_service_status_command *self)
 
void mip::C::insert_mip_rtk_service_status_response (microstrain_serializer *serializer, const mip_rtk_service_status_response *self)
 
void mip::C::extract_mip_rtk_service_status_response (microstrain_serializer *serializer, mip_rtk_service_status_response *self)
 
mip_cmd_result mip::C::mip_rtk_service_status (mip_interface *device, uint32_t reserved1, uint32_t reserved2, mip_rtk_service_status_command_service_flags *flags_out, uint32_t *received_bytes_out, uint32_t *last_bytes_out, uint64_t *last_bytes_time_out)
 
void mip::C::insert_mip_rtk_prod_erase_storage_command (microstrain_serializer *serializer, const mip_rtk_prod_erase_storage_command *self)
 
void mip::C::extract_mip_rtk_prod_erase_storage_command (microstrain_serializer *serializer, mip_rtk_prod_erase_storage_command *self)
 
mip_cmd_result mip::C::mip_rtk_prod_erase_storage (mip_interface *device, mip_media_selector media)
 
void mip::C::insert_mip_rtk_led_control_command (microstrain_serializer *serializer, const mip_rtk_led_control_command *self)
 
void mip::C::extract_mip_rtk_led_control_command (microstrain_serializer *serializer, mip_rtk_led_control_command *self)
 
mip_cmd_result mip::C::mip_rtk_led_control (mip_interface *device, const uint8_t *primary_color, const uint8_t *alt_color, mip_led_action act, uint32_t period)
 
mip_cmd_result mip::C::mip_rtk_modem_hard_reset (mip_interface *device)