Garmin Fleet Management Controller  2.19.0
fmi.h File Reference
#include "garmin_types.h"
#include "pack_begin.h"
#include "pack_end.h"

Go to the source code of this file.

Classes

struct  A602_server_to_client_open_text_msg_data_type
 Payload of FMI_ID_SERVER_OPEN_TXT_MSG packet. More...
 
struct  A602_stop_data_type
 Payload of FMI_ID_A602_STOP packet. More...
 
struct  A603_stop_data_type
 Payload of FMI_ID_A603_STOP packet. More...
 
struct  A604_server_to_client_open_text_msg_data_type
 Data type for the A604 Server to Client Open Text Message Packet ID. More...
 
struct  auto_arrival_data_type
 Payload of FMI_ID_AUTO_ARRIVAL packet. More...
 
struct  canned_message_data_type
 Data type for the Set Canned Message Packet ID. More...
 
struct  canned_message_delete_data_type
 Data type for the Delete Canned Message Packet ID. More...
 
struct  canned_message_receipt_data_type
 Data type for the Set Canned Message Receipt Packet ID and Delete Canned Message Receipt Packet ID. More...
 
struct  canned_response_data_type
 Data type for the Set Canned Response Packet ID. More...
 
struct  canned_response_delete_data_type
 Data type for the Delete Canned Response Packet ID. More...
 
struct  canned_response_list_data_type
 Data type for the Canned Response List Packet ID. More...
 
struct  canned_response_list_receipt_data_type
 Data type for Canned Response List Packet ID. More...
 
struct  canned_response_receipt_data_type
 Data type for the Set Canned Response Receipt Packet ID and Delete Canned Response Receipt Packet ID. More...
 
struct  category_data_type
 Data type for the FMI_ID_CREATE_WAYPOINT_CAT packet. More...
 
struct  category_rcpt_data_type
 Data type for the FMI_ID_CREATE_WAYPOINT_CAT_RCPT packet. More...
 
struct  client_to_server_D607_open_text_msg_data_type
 Payload of FMI_ID_A607_CLIENT_OPEN_TXT_MSG packet. More...
 
struct  client_to_server_open_text_msg_data_type
 Payload of FMI_ID_CLIENT_OPEN_TXT_MSG packet. More...
 
struct  client_to_server_text_msg_receipt_data_type
 Payload of FMI_ID_CLIENT_TXT_MSG_RCPT packet. More...
 
struct  custom_avoid_delete_type
 Data type for Custom Avoidance Delete (0X1232) from server to client. More...
 
struct  custom_avoid_enable_type
 Data type for Custom Avoidance Enable/Disable (0X1234) from server to client. More...
 
struct  custom_avoid_feature_enable_type
 Data type for Custom Avoidance Feature Enable Packet ID (0X1236, 0X1235) More...
 
struct  custom_avoid_rcpt_type
 Data type for Custom Avoidance Receipt ID (0X1231) from client to server. More...
 
struct  custom_avoid_type
 Data type for Custom Avoidance Packet ID (0X1230) from server to client. More...
 
struct  custom_form_delete_ack_type
 Data type for Custom Forms Packet ID (0X1201) from client to server. More...
 
struct  custom_form_move_type
 Data type for Custom Forms Packet ID (0X1202) from client to server. More...
 
struct  custom_form_position_ack_type
 Data type for Custom Forms Packet ID (0X1203, 0X1205) from client to server. More...
 
struct  custom_form_show_ack_type
 Data type for Custom Forms Packet ID (0X1207) from client to server. More...
 
struct  data_deletion_data_type
 Data type for the Data Deletion Packet ID. More...
 
struct  delete_by_category_rcpt_data_type
 Data type for the FMI_ID_DELETE_WAYPOINT_CAT_RCPT packet. More...
 
struct  delete_message_request_data_type
 Data type for the Message Status Request Packet ID. More...
 
struct  delete_message_response_data_type
 Data type for the Delete Message Status Packet ID. More...
 
struct  driver_id_D607_data_type
 Data type for Driver ID Update Packet ID. More...
 
struct  driver_id_data_type
 Data type for Driver ID Update Packet ID. More...
 
struct  driver_id_receipt_data_type
 Data type for Driver ID Receipt packet. More...
 
struct  driver_id_request_data_type
 Data type for Driver ID Request Packet ID. More...
 
struct  driver_login_service_data_type
 Data type for the Driver Login Data Packet ID (0X1101) from client to server. More...
 
struct  driver_login_service_receipt
 Data type for the Driver Login Data Packet ID (0X1102) from server to client. More...
 
struct  driver_status_D607_data_type
 Data type for the A607 Driver Status Update packet. More...
 
struct  driver_status_data_type
 Data type for the Driver Status Update packet. More...
 
struct  driver_status_list_item_data_type
 Data type for the Set Driver Status List Item packet. More...
 
struct  driver_status_list_item_delete_data_type
 Data type for Delete Driver Status List Item Receipt. More...
 
struct  driver_status_list_item_receipt_data_type
 Data type for the Set Driver Status List Item and Delete Driver Status List Item Receipt packets. More...
 
struct  driver_status_receipt_data_type
 Data type for the Driver Status Update Receipt packet. More...
 
struct  driver_status_request_data_type
 Data type for Driver Status Request Packet ID. More...
 
struct  eta_data_receipt_type
 Data type for the ETA Data Receipt Packet ID. More...
 
struct  eta_data_type
 Data type for the ETA Data Packet ID. More...
 
struct  eta_mode_setting_data_type
 Data type for the ETA Mode Type Packet ID (0X0203) from client to server (request) More...
 
struct  eta_mode_setting_response_data_type
 Data type for the ETA Data Receipt Packet ID. More...
 
struct  file_end_data_type
 Data type for File Transfer End. More...
 
struct  file_info_data_type
 Data type for the File Transfer Start Packet ID. More...
 
struct  file_packet_data_type
 Data type for File Data Packet ID. More...
 
struct  file_receipt_data_type
 Data type for File Start Receipt Packet ID and File End Receipt Packet ID. More...
 
struct  file_receipt_from_srvr_data_type
 Data type for File Start Receipt Packet ID and File End Receipt Packet ID when sent from Server. More...
 
struct  fmi_ack_type
 Data type for the Driver Profile Update Response Data Packet ID (?) from client to server. More...
 
struct  fmi_alert_popup_receipt
 Data type for Alert Popup Receipt Packet ID (0x1401) from client to server. More...
 
struct  fmi_alert_popup_request
 Data type for Alert Popup Request Packet ID (0x1400) from server to client. More...
 
struct  fmi_annotation_download_request_data_type
 Data type for the Annotation Download Request Packet ID (0X110C) from client to server. More...
 
struct  fmi_dashcam_get_ntfctn_settings_data_type
 Data type for Get Dashcam Notification Settings Packet ID (0X1609) from client to server. More...
 
struct  fmi_dashcam_get_settings_request_data_type
 Data type for Dashcam Get Settings Packet ID (0X1604, 0X1608) from server to client. More...
 
struct  fmi_dashcam_get_settings_response_data_type
 Data type for Dashcam Get Settings Packet ID (0X1605) from client to server. More...
 
struct  fmi_dashcam_lock_settings_request_data_type
 Data type for Dashcam Lock Settings Packet ID (0X1600) from server to client. More...
 
struct  fmi_dashcam_ntfctn_incident_req_data_type
 Data type for Dashcam Notification Packet ID (0X160C) from client to server (request) More...
 
struct  fmi_dashcam_ntfctn_receipt_data_type
 Data type for Dashcam Notifictation Packet ID (0X160A) from server to client (receipt) More...
 
struct  fmi_dashcam_ntfctn_req_data_type
 Data type for Dashcam Notification Packet ID (0X1606) from client to server (request) More...
 
struct  fmi_dashcam_receipt_data_type
 Data type for Dashcam Settings Packet ID (0X1601, 0X1603, 0x1607) from client to server. More...
 
struct  fmi_dashcam_set_config_request_data_type
 Data type for Dashcam Configure Settings Packet ID (0X1602) from server to client. More...
 
struct  fmi_dashcam_set_ntfctn_settings_data_type
 Data type for Set Dashcam Notification Settings Packet ID (0X1606) from server to client. More...
 
struct  fmi_dashcam_settings_list
 Holds individual setting values, utilized by Packet ID (0X1602, 0X1605) More...
 
struct  fmi_driver_annotation_data_type
 Data type for the Annotation Download Response Packet ID (0X110D) from server to client. More...
 
struct  fmi_driver_aobrd_ack_data_type
 Data type for the Annotation Download Receipt Packet ID (0X110E) from client to server. More...
 
struct  fmi_driver_profile_data_type
 Data type for the Driver Profile Data Packet ID (0X1104) from server to client. More...
 
struct  fmi_driver_profile_data_type_V2
 Data type for the Driver Profile Data Packet ID (0X1110) from server to client and Driver Profile Data Push Packet ID (0x1111) from server to client. More...
 
struct  fmi_driver_profile_type
 Data type for the Driver Profile Data Packet ID (0X1103) from client to server. More...
 
struct  fmi_driver_shipment_data_type
 Data type for the Shipment Download Response Packet ID (0X110A) from server to client. More...
 
struct  fmi_driver_status_log_dnld_resp_data_type
 Data type for the Driver Status Log response Packet ID (0X1107) from server to client. More...
 
struct  fmi_driver_status_update_request_data_type
 Data type for the Driver Status Log Update Data Packet ID (0X1106) from client to server. More...
 
struct  fmi_features_data_type
 Payload for FMI_ID_ENABLE. More...
 
struct  fmi_hos_auto_status_update_feature
 Data type for the HOS Auto Status Update Enable Packet ID (0X1300) from server to client. More...
 
struct  fmi_hos_auto_status_update_feature_rcpt
 Data type for the HOS Auto Status Update Receipt Packet ID (0X1301) from client to server. More...
 
struct  fmi_hos_set_settings_receipt_data_type
 Data type for HOS Settings Receipt Packet ID (0x1501) from client to server. More...
 
struct  fmi_hos_set_settings_request_data_type
 Data type for HOS Settings Request Packet ID (0x1500) from server to client. More...
 
struct  fmi_ifta_data_delete_receipt_type
 Data type for the IFTA Data Delete Receipt Packet ID (0X0009) from client to server. More...
 
struct  fmi_ifta_data_delete_request_type
 Data type for the IFTA Data Delete Request Packet ID (0X0008) from server to client. More...
 
struct  fmi_ifta_data_fetch_receipt_type
 Data type for the IFTA Data Fetch Receipt Packet ID (0X0007) from client to server. More...
 
struct  fmi_ifta_data_fetch_request_type
 Data type for the IFTA Data Fetch Request Packet ID (0X0006) from server to client. More...
 
struct  fmi_logoff_driver_receipt
 Data type for AOBRD Driver Logoff Receipt Packet ID (0X1311) from client to server. More...
 
struct  fmi_logoff_driver_request
 Data type for AOBRD Driver Logoff Request Packet ID (0X1310) from server to client. More...
 
struct  fmi_sensor_config_request
 Data type for Configure Sensor Request Packet ID (0x1402) from server to client. More...
 
struct  fmi_sensor_delete_request
 Data type for Delete Sensor Request Packet ID (0x1404) from server to client. More...
 
struct  fmi_sensor_query_display_index_receipt
 Data type for Query Sensor Display Index Receipt Packet ID (0x1408) from client to server. More...
 
struct  fmi_sensor_query_display_index_request
 Data type for Query Sensor Display Index Request Packet ID (0x1407) from server to client. More...
 
struct  fmi_sensor_receipt
 Data type for Configure/Update/Delete Sensor Receipt Packet IDs (0x1403,0x1405) from client to server. More...
 
struct  fmi_sensor_update_request
 Data type for Update Sensor Request Packet ID (0x1406) from server to client. More...
 
struct  fmi_set_baud_receipt
 Data type for Baud Rate Change Receipt Packet ID (0x0012) from client to server. More...
 
struct  fmi_set_baud_request
 Data type for Baud Rate Change Request Packet ID (0x0011) from server to client. More...
 
struct  fmi_shipment_download_receipt_data_type
 Data type for the Shipment Download Receipt Packet ID (0X110B) from client to server. More...
 
struct  fmi_status_log_download_receipt_data_type
 Data type for the Driver Status Log Receipt Packet ID (0X1108) from client to server. More...
 
struct  fmi_update_driver_profile_request_data_type
 Data type for the Driver Profile Update Data Packet ID (0X1105) from server to client. More...
 
struct  hosart_change_status
 Data type for Change Status HOSART Packet ID (0X0000) More...
 
struct  hosart_change_to_driving_warning
 Data type for Change to Driving Warning HOSART Packet ID (0X0001) More...
 
struct  hosart_violation_found
 Data type for Warning Found and Violation Found HOSART Packet IDs (0X0002,0X0003) More...
 
struct  long_text_msg_data_type
 Data type for Long Text Message Request Packet ID (0X0055) from server to client. More...
 
struct  long_text_msg_receipt_data_type
 Data type for Long Test Message Receipt Packet ID (0X0056) from client to server. More...
 
struct  message_status_data_type
 Data type for the Message Status Packet ID. More...
 
struct  message_status_request_data_type
 Data type for the Message Status Request Packet ID. More...
 
struct  message_throttling_data_type
 Data type for the Message Throttling Command Packet ID and Message Throttling Response Packet ID. More...
 
struct  message_throttling_list_data_type
 Data type for the Message Throttling Query Response Packet ID. More...
 
struct  packet_receipt_data_type
 Packet receipt for Packet Receipt Packet ID. More...
 
struct  product_id_data_type
 Payload for Garmin ID_PRODUCT_DATA (A000) and FMI FMI_ID_PRODUCT_ID_DATA (A602) packet. More...
 
struct  protocol_support_data_type
 Element of the array returned in Garmin ID_PROTOCOL_ARRAY (A001) or FMI_ID_PROTOCOL_DATA (A602) packets. More...
 
struct  pvt_data_type
 Payload for Garmin ID_PVT_DATA packet. More...
 
struct  request_canned_response_list_refresh_data_type
 List of canned responses that the client requests updated text for. More...
 
struct  safe_mode_speed_data_type
 Data type for the FMI Safe Mode setup Packet ID. More...
 
struct  safe_mode_speed_receipt_data_type
 Data type for the User Interface Text Receipt Packet ID. More...
 
struct  server_to_client_ack_text_msg_data_type
 Payload of server to client messages requiring a response (A602) More...
 
struct  server_to_client_text_msg_receipt_data_type
 Data type for the Server to Client Open Text Message Receipt Packet ID. More...
 
struct  set_odometer_request_data_type
 Data type for the Set Odometer Request Packed ID (0X1100) from server to client. More...
 
struct  speed_limit_alert_data_type
 Data type for the Speed Limit Alert Packet ID. More...
 
struct  speed_limit_alert_receipt_data_type
 Data type for the Speed Limit Alert Receipt Packet ID. More...
 
struct  speed_limit_data_type
 Data type for the Speed Limit Alerts setup Packet ID. More...
 
struct  speed_limit_receipt_data_type
 Data type for the Speed Limit Alerts setup Receipt Packet ID. More...
 
struct  stop_calc_ack_rcpt_type
 Data type for Route Calculation ACK Receipt Packet ID (0X1221) from server to client. More...
 
struct  stop_calc_ack_type
 Data type for Route Calculation ACK Packet ID (0X1220) from client to server. More...
 
struct  stop_status_data_type
 Payload of FMI_ID_STOP_STATUS and FMI_ID_STOP_STATUS_REQUEST packets. More...
 
struct  stop_status_receipt_data_type
 Payload of FMI_ID_STOP_STATUS_RCPT packet. More...
 
struct  text_msg_ack_data_type
 Payload of FMI_ID_TEXT_MSG_ACK packet. More...
 
struct  text_msg_id_data_type
 Data type for the Text Message Ack Receipt Packet ID. More...
 
struct  unit_id_data_type
 Payload for Garmin ID_UNIT_ID packet. More...
 
struct  user_interface_text_data_type
 Data type for the User Interface Text Packet ID. More...
 
struct  user_interface_text_receipt_data_type
 Data type for the User Interface Text Receipt Packet ID. More...
 
struct  waypoint_data_type
 Data type for FMI_ID_WAYPOINT packet. More...
 
struct  waypoint_rcpt_data_type
 Data type for the FMI_ID_WAYPOINT_RCPT packet. More...
 

Macros

#define FMI_DRIVER_COUNT   ( 3 )
 Number of supported drivers. More...
 
#define FMI_PROTOCOL_LEVEL   623
 
#define FMI_SUPPORT_A602   ( FMI_PROTOCOL_LEVEL >= 602 )
 If true, app was build with support for A602 protocols. More...
 
#define FMI_SUPPORT_A603   ( FMI_PROTOCOL_LEVEL >= 603 )
 If true, app was build with support for A603 protocols. More...
 
#define FMI_SUPPORT_A604   ( FMI_PROTOCOL_LEVEL >= 604 )
 If true, app was build with support for A604 protocols. More...
 
#define FMI_SUPPORT_A605   ( FMI_PROTOCOL_LEVEL >= 605 )
 If true, app was build with support for A605 protocols. More...
 
#define FMI_SUPPORT_A606   ( FMI_PROTOCOL_LEVEL >= 606 )
 If true, app was build with support for A606 protocols. More...
 
#define FMI_SUPPORT_A607   ( FMI_PROTOCOL_LEVEL >= 607 )
 If true, app was build with support for A607 protocols. More...
 
#define FMI_SUPPORT_A608   ( FMI_PROTOCOL_LEVEL >= 608 )
 If true, app was build with support for A608 protocols. More...
 
#define FMI_SUPPORT_A609   ( FMI_PROTOCOL_LEVEL >= 609 )
 If true, app was build with support for A609 protocols. More...
 
#define FMI_SUPPORT_A610   ( FMI_PROTOCOL_LEVEL >= 610 )
 If true, app was build with support for A610(AOBRD) protocols. More...
 
#define FMI_SUPPORT_A611   ( FMI_PROTOCOL_LEVEL >= 611 )
 If true, app was built with support for A611 protocols. More...
 
#define FMI_SUPPORT_A612   ( FMI_PROTOCOL_LEVEL >= 612 )
 If true, app was built with support for A612 protocols. More...
 
#define FMI_SUPPORT_A613   ( FMI_PROTOCOL_LEVEL >= 613 )
 If true, app was built with support for A613 protocols. More...
 
#define FMI_SUPPORT_A614   ( FMI_PROTOCOL_LEVEL >= 614 )
 If true, app was built with support for A614 protocols. More...
 
#define FMI_SUPPORT_A615   ( FMI_PROTOCOL_LEVEL >= 615 )
 If true, app was built with support for A615 protocols. More...
 
#define FMI_SUPPORT_A616   ( FMI_PROTOCOL_LEVEL >= 616 )
 If true, app was built with support for A616 protocols. More...
 
#define FMI_SUPPORT_A617   ( FMI_PROTOCOL_LEVEL >= 617 )
 If true, app was built with support for A617 protocols. More...
 
#define FMI_SUPPORT_A618   ( FMI_PROTOCOL_LEVEL >= 618 )
 If true, app was built with support for A618 protocols. More...
 
#define FMI_SUPPORT_A619   ( FMI_PROTOCOL_LEVEL >= 619 )
 If true, app was built with support for A619 protocols. More...
 
#define FMI_SUPPORT_A620   ( FMI_PROTOCOL_LEVEL >= 620 )
 If true, app was built with support for A620 protocols. More...
 
#define FMI_SUPPORT_A621   ( FMI_PROTOCOL_LEVEL >= 621 )
 If true, app was built with support for A621 protocols. More...
 
#define FMI_SUPPORT_A622   ( FMI_PROTOCOL_LEVEL >= 622 )
 If true, app was built with support for A622 protocols. More...
 
#define FMI_SUPPORT_A623   ( FMI_PROTOCOL_LEVEL >= 623 )
 If true, app was built with support for A622 protocols. More...
 
#define FMI_SUPPORT_LEGACY   ( !FMI_SUPPORT_A607 )
 If true, app was build with support for legacy protocols. More...
 
#define INVALID16   0xFFFF
 Placeholder for an invalid 16-bit value. More...
 
#define INVALID32   0xFFFFFFFF
 Placeholder for an invalid 32-bit value. More...
 
#define INVALID_LAT   0x7FFFFFFFL
 placeholder for invalid latitude value More...
 
#define LOG_SHOW_RAW_ASCII   ( TRUE )
 If TRUE, interpret the raw packet as ASCII. More...
 
#define LONG_TEXT_MSG_CHUNK_SIZE   ( 200 )
 Maximum number of bytes in one segment of an A611 Long Text Message. More...
 
#define LONG_TEXT_MSG_MAX_SIZE   ( 2000 )
 Maximum number of bytes in an A611 Long Text Message. More...
 
#define MAX_THROTTLED_PROTOCOLS   60
 Maximum number of protocols that can be throttled. More...
 
#define MINIMAL_ENABLE   ( FALSE )
 If TRUE, the Enable is minimal. More...
 
#define PROTOCOL_SIZE   ( MAX_PAYLOAD_SIZE / sizeof( protocol_support_data_type ) * 5 + 1 )
 Size of the formatted "supported protocols" string. More...
 
#define SKIP_VALIDATION   ( FALSE )
 If TRUE, no validation of inputs is performed in the UI. More...
 
#define TEXT_MSG_BUFFER_MAX_SIZE   LONG_TEXT_MSG_MAX_SIZE
 The maximum size of any text message, in bytes. More...
 
#define TEXT_MSG_MAX_SIZE   ( 200 )
 Maximum payload of a single text message, in bytes. More...
 
#define UNICODE_ENABLED   ( TRUE )
 If TRUE, the server supports Unicode. More...
 

Typedefs

typedef uint16 command_type
 Garmin command ID (payload when packet ID == ID_COMMAND_BYTE) More...
 
typedef uint8 FMI_eta_mode_type
 
typedef uint8 FMI_eta_setting_rcode
 
typedef uint16 fmi_id_type
 Fleet Management packet ID (first two bytes of payload when Garmin packet ID == ID_FMI_PACKET) More...
 
typedef uint16 message_throttling_state_type
 Type for new_state from the message_throttling_data_type. More...
 
typedef uint16 stop_status_status_type
 Enumeration for Stop Status protocol. More...
 
typedef waypoint_rcpt_data_type waypoint_deleted_data_type
 Data type for the FMI_ID_WAYPOINT_DELETED packet. More...
 

Enumerations

enum  a604_message_type {
  A604_MESSAGE_TYPE_NORMAL = 0,
  A604_MESSAGE_TYPE_DISP_IMMEDIATE = 1
}
 Valid values for the message_type field of the A604_server_to_client_open_text_msg_data_type. More...
 
enum  aobrd_download_receipt_result_code {
  FMI_LOGIN_NO_ERRORS = 0,
  FMI_LOGIN_WRONG_ID_SERVER_RESPONSE = 1,
  FMI_LOGIN_INVALID_ID_SERVER_RESPONSE = 2,
  FMI_LOGIN_UNEXPECTED_RESPONSE_PACKET = 3,
  FMI_LOGIN_SHIPMENT_DB_ERROR = 4,
  FMI_LOGIN_ANNOTATION_DB_ERROR = 5
}
 Enum for log status/shipment download packet receipt result code. More...
 
enum  AOBRD_download_response_result_code {
  CONTAINS_DATA = 0,
  EMPTY_DATA = 1,
  UNKNOWN_DRIVER = 2,
  UNSUPPORTED = 3
}
 Enum for shipment download packet content type. More...
 
enum  aobrd_time_zone {
  EASTERN = 0,
  CENTRAL = 1,
  MOUNTAIN = 2,
  PACIFIC = 3,
  ALASKA = 4,
  HAWAII = 5,
  TIME_ZONE_COUNT
}
 Enum for supported time zone IDs. More...
 
enum  aobrd_update_result_code_type {
  UPDATE_ACCEPT,
  UPDATE_FAIL,
  UPDATE_DECLINE,
  UPDATE_NOT_READY,
  UPDATE_NO_DATA,
  UPDATE_STORAGE_ERROR,
  UPDATE_RESULT_ERROR,
  UPDATE_INTERFACE_ERROR,
  NUM_OF_UPDATE_PROFILE_CODES
}
 Enum for fmi_ack_type. More...
 
enum  canned_response_list_result {
  CANNED_RESP_LIST_SUCCESS = 0,
  CANNED_RESP_LIST_INVALID_COUNT = 1,
  CANNED_RESP_LIST_INVALID_MSG_ID = 2,
  CANNED_RESP_LIST_DUPLICATE_MSG_ID = 3,
  CANNED_RESP_LIST_FULL = 4
}
 Enumeration for result_code from the canned_response_list packet. More...
 
enum  codepage_type {
  CODEPAGE_ASCII = 1252,
  CODEPAGE_UNICODE = CP_UTF8
}
 The code page used for encoding of text fields sent to or received from the client. More...
 
enum  command_enum {
  COMMAND_REQ_DATE_TIME = 5,
  COMMAND_REQ_UNIT_ID = 14,
  COMMAND_TURN_ON_PVT_DATA = 49,
  COMMAND_TURN_OFF_PVT_DATA = 50
}
 Garmin command ID. More...
 
enum  del_data {
  DELETE_ALL_STOPS = 0,
  DELETE_ALL_MESSAGES = 1,
  DELETE_ACTIVE_ROUTE = 2,
  DELETE_CANNED_MESSAGES = 3,
  DELETE_CANNED_RESPONSES = 4,
  DELETE_GPI_FILE = 5,
  DELETE_DRIVER_ID_AND_STATUS = 6,
  DISABLE_FMI = 7,
  DELETE_WAYPOINTS = 8,
  DELETE_FORMS = 10,
  DELETE_CUSTOM_AVOIDANCES = 11,
  DELETE_SENSORS = 12
}
 Enumeration for Data Deletion protocol. More...
 
enum  file_result_data_type {
  FMI_FILE_RESULT_SUCCESS = 0,
  FMI_FILE_RESULT_CRC_ERROR = 1,
  FMI_FILE_RESULT_LOW_MEM = 2,
  FMI_FILE_RESULT_INVALID_FILE = 3,
  FMI_FILE_RESULT_NO_TRANSFER = 4,
  FMI_FILE_RESULT_SEVERE = 5,
  FMI_FILE_RESULT_INVALID_FILE_TYPE = 6,
  FMI_FILE_RESULT_INVALID_GPI_FILE = 7,
  FMI_FILE_START_OPEN_ERROR = 8,
  FMI_FILE_START_CLOSE_ERROR = 9,
  FMI_FILE_RESULT_FINALIZE_ERROR = 10,
  FMI_FILE_RESULT_NOT_PROCESSED = 11,
  FMI_FILE_RESULT_RX_GZIP_ERROR = 12,
  FMI_FILE_RESULT_BUSY = 13
}
 Valid values for file transfer result. More...
 
enum  file_type_type {
  FMI_FILE_TYPE_GPI,
  FMI_FILE_TYPE_AOBRD = 1,
  FMI_FILE_TYPE_CUSTOM_FORMS = 2,
  FMI_FILE_TYPE_PATH_SPECIFIC_ROUTE = 3,
  FMI_FILE_TYPE_IFTA = 4,
  FMI_FILE_TYPE_LONG_STOP = 5,
  FMI_FILE_TYPE_CNT
}
 Valid values for file transfer types. More...
 
enum  fmi_A604_message_status {
  MESSAGE_STATUS_UNREAD = 0,
  MESSAGE_STATUS_READ = 1,
  MESSAGE_STATUS_NOT_FOUND = 2
}
 Enum for A604 message status protocol. More...
 
enum  fmi_alert_popup_icons {
  FMI_ALERT_ICON_NONE,
  FMI_ALERT_ICON_DRIVER_BEHAVIOR,
  FMI_ALERT_ICON_TIRE_PRESSURE,
  FMI_ALERT_ICON_TEMPERATURE,
  FMI_ALERT_ICON_DOOR_SENSOR,
  FMI_ALERT_ICON_VEHICLE_MAINTENANCE,
  FMI_ALERT_ICON_OBD2_GENERIC_SENSOR,
  FMI_ALERT_ICON_GENERIC_SENSOR1,
  FMI_ALERT_ICON_GENERIC_SENSOR2,
  FMI_ALERT_ICON_GENERIC_SENSOR3,
  FMI_ALERT_ICON_GENERAL_CONNECTIVITY,
  FMI_ALERT_ICON_DAILY_HOURS_COUNTER,
  FMI_ALERT_ICON_WEEKLY_HOURS_COUNTER,
  FMI_ALERT_ICON_REST_HOURS_COUNTER,
  FMI_ALERT_ICON_BREAK_HOURS_COUNTER,
  FMI_ALERT_ICON_TASKS,
  FMI_ALERT_ICON_WEIGHT,
  FMI_ALERT_ICON_INFORMATION,
  FMI_ALERT_ICON_FUEL,
  FMI_ALERT_ICON_EU_AVAILABLE,
  FMI_ALERT_ICON_EU_DRIVING,
  FMI_ALERT_ICON_EU_REST,
  FMI_ALERT_ICON_EU_WORK,
  FMI_ALERT_ICON_RESERVED
}
 Enum for Alert Popup predefined icon numbers. More...
 
enum  fmi_alert_popup_result_code_type {
  FMI_ALERT_POPUP_SUCCESS,
  FMI_ALERT_TEXT_TOO_LONG,
  FMI_ALERT_ICON_NUM_OUT_OF_RANGE,
  FMI_ALERT_MISSING_ALERT_TEXT_AND_ICON,
  FMI_ALERT_SEVERITY_OUT_OF_RANGE,
  FMI_ALERT_TIMEOUT_OUT_OF_RANGE
}
 Enum for Alert Popup receipt result code. More...
 
enum  fmi_alert_popup_severities {
  FMI_ALERT_SEVERITY_NORMAL,
  FMI_ALERT_SEVERITY_MEDIUM,
  FMI_ALERT_SEVERITY_HIGH
}
 Enum for Alert Popup predefined icon numbers. More...
 
enum  fmi_baud_rate_code_type {
  FMI_BAUD_RATE_9600 = 0x06,
  FMI_BAUD_RATE_38400 = 0x0a,
  FMI_BAUD_RATE_57600 = 0x0c
}
 Enum for Baud Rate code type. More...
 
enum  fmi_baud_request_type {
  FMI_BAUD_NEW_RATE_REQUEST,
  FMI_BAUD_RATE_SYNC_REQUEST
}
 Enum for Baud Rate request type. More...
 
enum  fmi_baud_result_code_type {
  FMI_BAUD_RATE_OK,
  FMI_BAUD_REQUEST_TYPE_SERVER_ERROR,
  FMI_BAUD_RATE_SERVER_ERROR,
  FMI_BAUD_RATE_CONTROL_IS_DISABLED,
  FMI_BAUD_RATE_CLIENT_ERROR = 0x10,
  FMI_BAUD_SET_ERROR,
  FMI_BAUD_PLUG_ID_ERROR
}
 Enum for Baud Rate receipt result code. More...
 
enum  FMI_custom_avoid_response_codes {
  CUSTOM_AVOID_SUCCESS = 0,
  CUSTOM_AVOID_ID_NOT_FOUND = 1,
  CUSTOM_AVOID_ERR_FULL = 2,
  CUSTOM_AVOID_ERR_NV = 3,
  CUSTOM_AVOID_ERR_NM_INUSE = 4,
  CUSTOM_AVOID_ERR_FEAT_NOT_ENBL = 5,
  CUSTOM_AVOID_ERR_ID_OUT_OF_RANGE = 6
}
 
enum  fmi_dashcam_ntfctn {
  DASHCAM_INCIDENT_NTFCTN,
  DASHCAM_FCW_NTFCTN,
  DASHCAM_LDW_NTFCTN
}
 
enum  fmi_dashcam_receipt_result_code_type {
  DASHCAM_SUCCESS = 0,
  DASHCAM_ERR_LOCK_ADAS_FEATURE_NOT_SUPPORT = 1,
  DASHCAM_ERR_AFTER_POWER_LOSS_SETTINGS_OUT_OF_RANGE = 2,
  DASHCAM_ERR_RECORDER_RESOLUTION_OUT_OF_RANGE = 3,
  DASHCAM_ERR_FCWS_SENSITIVITY_OUT_OF_RANGE = 4,
  DASHCAM_ERR_SETTING_ID_OUT_OF_RANGE = 5,
  DASHCAM_ERR_INTERNAL = 6,
  DASHCAM_ERR_FCW_LDW_NTFCTN_NOT_SUPPORT = 7,
  DASHCAM_ERR_FCW_NOT_ENABLED = 8,
  DASHCAM_ERR_LDW_NOT_ENABLED = 9,
  DASHCAM_ERR_INCIDENT_NOT_ENABLED = 10
}
 
enum  fmi_dashcam_setting {
  DASHCAM_FORWARD_COLLISION,
  DASHCAM_COLLISION_SENSITIVITY,
  DASHCAM_LANE_DEPARTURE,
  DASHCAM_RECORD_ON_STARTUP,
  DASHCAM_INCIDENT_DETECTION,
  DASHCAM_RECORD_AUDIO,
  DASHCAM_DATA_OVERLAY_DATE_TIME,
  DASHCAM_DATA_OVERLAY_LOCATION_SPEED,
  DASHCAM_VIDEO_RESOLUTION,
  DASHCAM_RECORD_AFTER_POWER_LOSS
}
 
enum  FMI_eta_mode_type_enum {
  ETA_SETTING_NONE = 0,
  ETA_SETTING_DISPATCH = 1,
  ETA_SETTING_DRIVER = 2,
  ETA_SETTING_DISPATCH_AND_DRIVER = 3
}
 
enum  FMI_eta_setting_rcdoe_enum {
  FMI_ETA_SETTING_SUCCESS = 0,
  FMI_ETA_SETTING_RANGE_ERROR = 1,
  FMI_ETA_SETTING_NV_FAILURE = 2
}
 
enum  fmi_feature_type {
  FEATURE_ID_UNICODE = 1,
  FEATURE_ID_A607_SUPPORT = 2,
  FEATURE_ID_DRIVER_PASSWORDS = 10,
  FEATURE_ID_MULTIPLE_DRIVERS = 11,
  FEATURE_ID_AOBRD_SUPPORT = 12,
  FEATURE_STATE_ENABLED = 1 << 15,
  FEATURE_STATE_DISABLED = 0 << 15,
  FEATURE_ID_MASK = setbits( 0, 15 ),
  FEATURE_STATE_MASK = setbits( 15, 1 )
}
 Valid values for the features field of the fmi_features_data_type. More...
 
enum  FMI_long_text_response_codes_t8 {
  LONG_TEXT_SUCCESS = 0,
  LONG_TEXT_INVALID_ID_SIZE = 1,
  LONG_TEXT_NON_ZERO_SEQ_NUM_ERROR = 2,
  LONG_TEXT_ID_IN_USE_SQL_ERROR = 3,
  LONG_TEXT_ID_IN_USE_ERROR = 4,
  LONG_TEXT_MALLOC_BUFFER_FAIL = 5,
  LONG_TEXT_WRONG_ID_SIZE = 6,
  LONG_TEXT_WRONG_ID_ERROR = 7,
  LONG_TEXT_NON_INC_SEQ_NUM_ERROR = 8,
  LONG_TEXT_WRONG_ORIG_TIME = 9,
  LONG_TEXT_WRONG_MESSAGE_TYPE = 10,
  LONG_TEXT_EXCEEDED_MAX_BYTES = 11,
  LONG_TEXT_APPEND_NULL_PTR = 12,
  LONG_TEXT_SAVE_SQL_NULL_PTR = 13,
  LONG_TEXT_MALLOC_INBOX_FAIL = 14,
  LONG_TEXT_SQL_INSERT_FAIL = 15
}
 
enum  fmi_packet_id_enum {
  FMI_ID_ENABLE = 0x0000,
  FMI_ID_PRODUCT_ID_SUPPORT_RQST = 0x0001,
  FMI_ID_PRODUCT_ID_DATA = 0x0002,
  FMI_ID_PROTOCOL_DATA = 0x0003,
  FMI_ID_UNICODE_REQUEST = 0x0004,
  FMI_ID_UNICODE_RESPONSE = 0x0005,
  FMI_ID_TEXT_MSG_ACK = 0x0020,
  FMI_ID_SERVER_OPEN_TXT_MSG = 0x0021,
  FMI_ID_SERVER_OK_ACK_TXT_MSG = 0x0022,
  FMI_ID_SERVER_YES_NO_CONFIRM_MSG = 0x0023,
  FMI_ID_CLIENT_OPEN_TXT_MSG = 0x0024,
  FMI_ID_CLIENT_TXT_MSG_RCPT = 0x0025,
  FMI_ID_A607_CLIENT_OPEN_TXT_MSG = 0x0026,
  FMI_ID_SET_CANNED_RESP_LIST = 0x0028,
  FMI_ID_CANNED_RESP_LIST_RCPT = 0x0029,
  FMI_ID_A604_OPEN_TEXT_MSG = 0x002A,
  FMI_ID_A604_OPEN_TEXT_MSG_RCPT = 0x002B,
  FMI_ID_TEXT_MSG_ACK_RCPT = 0x002C,
  FMI_ID_TEXT_MSG_DELETE_REQUEST = 0x002D,
  FMI_ID_TEXT_MSG_DELETE_RESPONSE = 0x002E,
  FMI_ID_SET_CANNED_RESPONSE = 0x0030,
  FMI_ID_DELETE_CANNED_RESPONSE = 0x0031,
  FMI_ID_SET_CANNED_RESPONSE_RCPT = 0x0032,
  FMI_ID_DELETE_CANNED_RESPONSE_RCPT = 0x0033,
  FMI_ID_REFRESH_CANNED_RESP_LIST = 0x0034,
  FMI_ID_TEXT_MSG_STATUS_REQUEST = 0x0040,
  FMI_ID_TEXT_MSG_STATUS = 0x0041,
  FMI_ID_SET_CANNED_MSG = 0x0050,
  FMI_ID_SET_CANNED_MSG_RCPT = 0x0051,
  FMI_ID_DELETE_CANNED_MSG = 0x0052,
  FMI_ID_DELETE_CANNED_MSG_RCPT = 0x0053,
  FMI_ID_REFRESH_CANNED_MSG_LIST = 0x0054,
  FMI_ID_LONG_TEXT_MSG = 0x0055,
  FMI_ID_LONG_TEXT_MSG_RCPT = 0x0056,
  FMI_ID_A602_STOP = 0x0100,
  FMI_ID_A603_STOP = 0x0101,
  FMI_ID_SORT_STOP_LIST = 0x0110,
  FMI_ID_SORT_STOP_LIST_ACK = 0x0111,
  FMI_ID_WAYPOINT = 0x0130,
  FMI_ID_WAYPOINT_RCPT = 0x0131,
  FMI_ID_WAYPOINT_DELETE = 0x0132,
  FMI_ID_WAYPOINT_DELETED = 0x0133,
  FMI_ID_WAYPOINT_DELETED_RCPT = 0x0134,
  FMI_ID_DELETE_WAYPOINT_CAT = 0x0135,
  FMI_ID_DELETE_WAYPOINT_CAT_RCPT = 0x0136,
  FMI_ID_CREATE_WAYPOINT_CAT = 0x0137,
  FMI_ID_CREATE_WAYPOINT_CAT_RCPT = 0x0138,
  FMI_ID_ETA_DATA_REQUEST = 0x0200,
  FMI_ID_ETA_DATA = 0x0201,
  FMI_ID_ETA_DATA_RCPT = 0x0202,
  FMI_ID_STOP_STATUS_REQUEST = 0x0210,
  FMI_ID_STOP_STATUS = 0x0211,
  FMI_ID_STOP_STATUS_RCPT = 0x0212,
  FMI_ID_AUTO_ARRIVAL = 0x0220,
  FMI_ID_DATA_DELETION = 0x0230,
  FMI_ID_USER_INTERFACE_TEXT = 0x0240,
  FMI_ID_USER_INTERFACE_TEXT_RCPT = 0x0241,
  FMI_ID_MSG_THROTTLING_COMMAND = 0x0250,
  FMI_ID_MSG_THROTTLING_RESPONSE = 0x0251,
  FMI_ID_MSG_THROTTLING_QUERY = 0x0252,
  FMI_ID_MSG_THROTTLING_QUERY_RESPONSE = 0x0253,
  FMI_ID_PING = 0x0260,
  FMI_ID_PING_RESPONSE = 0x0261,
  FMI_ID_FILE_TRANSFER_START = 0x0400,
  FMI_ID_FILE_DATA_PACKET = 0x0401,
  FMI_ID_FILE_TRANSFER_END = 0x0402,
  FMI_ID_FILE_START_RCPT = 0x0403,
  FMI_ID_FILE_PACKET_RCPT = 0x0404,
  FMI_ID_FILE_END_RCPT = 0x0405,
  FMI_ID_GPI_FILE_INFORMATION_REQUEST = 0x0406,
  FMI_ID_GPI_FILE_INFORMATION = 0x0407,
  FMI_ID_SET_DRIVER_STATUS_LIST_ITEM = 0x0800,
  FMI_ID_DELETE_DRIVER_STATUS_LIST_ITEM = 0x0801,
  FMI_ID_SET_DRIVER_STATUS_LIST_ITEM_RCPT = 0x0802,
  FMI_ID_DEL_DRIVER_STATUS_LIST_ITEM_RCPT = 0x0803,
  FMI_ID_DRIVER_STATUS_LIST_REFRESH = 0x0804,
  FMI_ID_DRIVER_ID_REQUEST = 0x0810,
  FMI_ID_DRIVER_ID_UPDATE = 0x0811,
  FMI_ID_DRIVER_ID_RCPT = 0x0812,
  FMI_ID_DRIVER_ID_UPDATE_D607 = 0x0813,
  FMI_ID_DRIVER_STATUS_REQUEST = 0x0820,
  FMI_ID_DRIVER_STATUS_UPDATE = 0x0821,
  FMI_ID_DRIVER_STATUS_RCPT = 0x0822,
  FMI_ID_DRIVER_STATUS_UPDATE_D607 = 0x0823,
  FMI_SAFE_MODE = 0x0900,
  FMI_SAFE_MODE_RESP = 0x0901,
  FMI_SPEED_LIMIT_SET = 0X1000,
  FMI_SPEED_LIMIT_RCPT = 0X1001,
  FMI_SPEED_LIMIT_ALERT = 0X1002,
  FMI_SPEED_LIMIT_ALERT_RCPT = 0X1003,
  FMI_REBOOT_DEVICE_REQUEST = 0X1010,
  FMI_SET_ODOMETER_REQUEST = 0X1100,
  FMI_DRIVER_LOGIN_REQUEST = 0X1101,
  FMI_DRIVER_LOGIN_RESPONSE = 0X1102,
  FMI_DRIVER_PROFILE_DOWNLOAD_REQUEST = 0X1103,
  FMI_DRIVER_PROFILE_DOWNLOAD_RESPONSE = 0X1104,
  FMI_DRIVER_PROFILE_UPDATE = 0X1105,
  FMI_DRIVER_STATUS_UPDATE_REQUEST = 0X1106,
  FMI_DRIVER_STATUS_UPDATE_RESPONSE = 0X1107,
  FMI_DRIVER_STATUS_UPDATE_RECEIPT = 0X1108,
  FMI_DOWNLOAD_SHIPMENTS_REQUEST = 0X1109,
  FMI_SHIPMENT_DOWNLOAD_RESPONSE = 0X110A,
  FMI_SHIPMENT_DOWNLOAD_RECEIPT = 0X110B,
  FMI_DRIVER_PROFILE_UPDATE_RESPONSE = 0X110C,
  FMI_ANNOTATION_DOWNLOAD_REQUEST = 0X110D,
  FMI_ANNOTATION_DOWNLOAD_RESPONSE = 0X110E,
  FMI_ANNOTATION_DOWNLOAD_RECEIPT = 0X110F,
  FMI_CUSTOM_FORM_DEL_REQUEST = 0x1200,
  FMI_CUSTOM_FORM_DEL_RECEIPT = 0x1201,
  FMI_CUSTOM_FORM_MOVE_REQUEST = 0x1202,
  FMI_CUSTOM_FORM_MOVE_RECEIPT = 0x1203,
  FMI_CUSTOM_FORM_GET_POS_REQUEST = 0x1204,
  FMI_CUSTOM_FORM_GET_POS_RECEIPT = 0x1205,
  FMI_CUSTOM_FORM_SHOW_REQUEST = 0x1206,
  FMI_CUSTOM_FORM_SHOW_RECEIPT = 0x1207,
  FMI_STOP_CALC_ACK_REQUEST = 0x1220,
  FMI_STOP_CALC_ACK_RECEIPT = 0x1221,
  FMI_CUSTOM_AVOID_ADD_REQUEST = 0X1230,
  FMI_CUSTOM_AVOID_ADD_RECEIPT = 0X1231,
  FMI_CUSTOM_AVOID_DEL_REQUEST = 0X1232,
  FMI_CUSTOM_AVOID_DEL_RECEIPT = 0X1233,
  FMI_CUSTOM_AVOID_TOGGLE_REQUEST = 0X1234,
  FMI_CUSTOM_AVOID_TOGGLE_RECEIPT = 0X1235,
  FMI_CUSTOM_AVOID_ENABLE_FEATURE_REQUEST = 0X1236,
  FMI_CUSTOM_AVOID_ENABLE_FEATURE_RECEIPT = 0X1237,
  FMI_IFTA_DATA_FETCH_REQUEST = 0X0006,
  FMI_IFTA_DATA_FETCH_RECEIPT = 0X0007,
  FMI_IFTA_DATA_DELETE_REQUEST = 0X0008,
  FMI_IFTA_DATA_DELETE_RECEIPT = 0X0009,
  FMI_DRIVER_PROFILE_UPDATE_V2 = 0X1110,
  FMI_DRIVER_PROFILE_DOWNLOAD_RESPONSE_V2 = 0X1111,
  FMI_HOS_AUTO_STATUS_FEATURE_REQUEST = 0X1300,
  FMI_HOS_AUTO_STATUS_FEATURE_RECEIPT = 0X1301,
  FMI_AOBRD_DRIVER_LOGOFF_REQUEST = 0X1310,
  FMI_AOBRD_DRIVER_LOGOFF_RECEIPT = 0X1311,
  FMI_HOS_8_HOUR_RULE_ENABLE_REQUEST = 0X1312,
  FMI_HOS_8_HOUR_RULE_ENABLE_RECEIPT = 0X1313,
  FMI_SET_BAUD_REQUEST = 0X0011,
  FMI_SET_BAUD_RECEIPT = 0X0012,
  FMI_ALERT_POPUP_REQUEST = 0X1400,
  FMI_ALERT_POPUP_RECEIPT = 0X1401,
  FMI_SENSOR_CONFIG_REQUEST = 0X1402,
  FMI_SENSOR_CONFIG_RECEIPT = 0X1403,
  FMI_SENSOR_DELETE_REQUEST = 0X1404,
  FMI_SENSOR_DELETE_RECEIPT = 0X1405,
  FMI_SENSOR_UPDATE_REQUEST = 0X1406,
  FMI_SENSOR_QUERY_DISPLAY_INDEX_REQUEST = 0X1407,
  FMI_SENSOR_QUERY_DISPLAY_INDEX_RECEIPT = 0X1408,
  FMI_HOS_SET_SETTING_DATA_REQUEST = 0X1500,
  FMI_HOS_SET_SETTING_DATA_RECEIPT = 0X1501,
  FMI_DASHCAM_SETTINGS_LOCK_REQUEST = 0X1600,
  FMI_DASHCAM_SETTINGS_LOCK_RECEIPT = 0X1601,
  FMI_DASHCAM_CONFIG_REQUEST = 0X1602,
  FMI_DASHCAM_CONFIG_RECEIPT = 0X1603,
  FMI_DASHCAM_GET_SETTINGS_REQUEST = 0X1604,
  FMI_DASHCAM_GET_SETTINGS_RESPONSE = 0X1605,
  FMI_DASHCAM_SET_NTFCTN_REQUEST = 0X1606,
  FMI_DASHCAM_SET_NTFCTN_RECEIPT = 0X1607,
  FMI_DASHCAM_GET_NTFCTN_SETTINGS_REQUEST = 0X1608,
  FMI_DASHCAM_GET_NTFCTN_SETTINGS_RESPONSE = 0X1609,
  FMI_DASHCAM_NTFCTN_REQUEST = 0X160A,
  FMI_DASHCAM_NTFCTN_RECEIPT = 0X160B,
  FMI_DASHCAM_INCDNT_FILE_NTFCTN_REQUEST = 0X160C,
  FMI_DASHCAM_INCDNT_FILE_NTFCTN_RECEIPT = 0X160D,
  FMI_ID_ETA_MODE_REQUEST = 0X0203,
  FMI_ID_ETA_MODE_RCPT = 0X0204,
  FMI_ID_END = 0xFFFF
}
 Fleet Management packet ID. More...
 
enum  fmi_sensor_create_result_code_type {
  FMI_SENSOR_SUCCESS,
  FMI_SENSOR_ERR_NAME_TOO_LONG,
  FMI_SENSOR_ERR_ICON_NUM_OUT_OF_RANGE,
  FMI_SENSOR_ERR_MISSING_SENSOR_NAME,
  FMI_SENSOR_ERR_SEVERITY_OUT_OF_RANGE,
  FMI_SENSOR_ERR_STATUS_TOO_LONG,
  FMI_SENSOR_ERR_DESCR_TOO_LONG,
  FMI_SENSOR_ERR_TOO_MANY_SENSORS,
  FMI_SENSOR_ERR_ID_NOT_FOUND,
  FMI_SENSOR_ERR_DB
}
 Enum for Sensor receipt result code. More...
 
enum  gps_fix_type {
  GPS_FIX_UNUSABLE = 0,
  GPS_FIX_INVALID = 1,
  GPS_FIX_2D = 2,
  GPS_FIX_3D = 3,
  GPS_FIX_2D_DIFF = 4,
  GPS_FIX_3D_DIFF = 5
}
 Possible values for pvt_data_type.type_of_gps_fix. More...
 
enum  HOS_setting_tag_type {
  HOS_SETTING_AUTO_STATUS_STOP_MOVING_THRESHOLD_SECONDS,
  HOS_SETTING_EIGHT_HOUR_RULE_ENABLE,
  HOS_SETTING_PERIODIC_STATUS_PERIOD_SECONDS,
  HOS_SETTING_START_TIME_OF_DAY,
  HOS_SETTING_LAST = HOS_SETTING_PERIODIC_STATUS_PERIOD_SECONDS
}
 Enum for HOS config setting type. More...
 
enum  HOS_settings_result_code_type {
  FMI_HOS_SETTING_RESULT_OK,
  FMI_HOS_SETTING_RESULT_SET_TO_MIN,
  FMI_HOS_SETTING_RESULT_SET_TO_MAX,
  FMI_HOS_SETTING_RESULT_FAIL = 0xFF
}
 Enum for Auto Status Update result code. More...
 
enum  hosart_packet_ids {
  HOSART_CHANGE_STATUS = 0,
  HOSART_CHANGE_TO_DRIVING_WARNING,
  HOSART_WARNING_FOUND,
  HOSART_VIOLATION_FOUND,
  HOSART_SET_PS_TO_OFF
}
 HOSART packet ID. More...
 
enum  HosLoadTypeRuleSet {
  HOS_RULES_LOAD_TYPE_PROPERTY,
  HOS_RULES_LOAD_TYPE_PASSENGER,
  NUM_HOS_RULES_LOAD_TYPE
}
 
enum  id_enum {
  ID_COMMAND_BYTE = 10,
  ID_UNIT_ID = 38,
  ID_DATE_TIME_DATA = 14,
  ID_PVT_DATA = 51,
  ID_FMI_PACKET = 161,
  ID_HOSART_PACKET = 218,
  ID_SET_TIME_PACKET = 219,
  ID_PROTOCOL_ARRAY = 253,
  ID_PRODUCT_RQST = 254,
  ID_PRODUCT_DATA = 255
}
 Garmin packet ID. More...
 
enum  IFTA_data_mod_result_code_type {
  FMI_IFTA_OK,
  FMI_IFTA_EXPORT_NO_DATA_FOUND,
  FMI_IFTA_BUSY_ERROR = 0x10,
  FMI_IFTA_NULL_INPUT_PTR_ERROR,
  FMI_IFTA_STATE_ERROR,
  FMI_IFTA_MIN_DATA_SIZE_ERROR,
  FMI_IFTA_MAX_DATA_SIZE_ERROR,
  FMI_IFTA_MALLOC_ERROR,
  FMI_IFTA_GZIP_ERROR,
  FMI_IFTA_GFS_OPEN_ERROR,
  FMI_IFTA_GFS_DIR_OPEN_ERROR,
  FMI_IFTA_GFS_FSTAT_ERROR,
  FMI_IFTA_GFS_READ_ERROR,
  FMI_IFTA_GFS_REMOVE_ERROR,
  FMI_IFTA_EXPORT_DATA_ERROR,
  FMI_IFTA_DATA_GFS_WRITE_ERROR,
  FMI_IFTA_TX_ERROR
}
 Enum for IFTA file fetch receipt. More...
 
enum  message_throttling_state_enum {
  MESSAGE_THROTTLE_STATE_DISABLE = 0,
  MESSAGE_THROTTLE_STATE_ENABLE = 1,
  MESSAGE_THROTTLE_STATE_ERROR = 4095
}
 Enumeration for new_state from the message_throttling_data_type. More...
 
enum  speed_limit_alert_category_type {
  SPEED_LIMIT_ALERT_BEGIN = 0,
  SPEED_LIMIT_ALERT_CHANGE = 1,
  SPEED_LIMIT_ALERT_END = 2,
  SPEED_LIMIT_ALERT_ERROR = 3,
  SPEED_LIMIT_ALERT_INVALID = 4
}
 Enum for speed limit alert category. More...
 
enum  speed_limit_alert_mode_type {
  SPEED_LIMIT_MODE_CAR = 0,
  SPEED_LIMIT_MODE_OFF = 1,
  SPEED_LIMIT_MODE_TRUCK = 2,
  SPEED_LIMIT_MODE_CNT
}
 Enum for speed limit alert mode. More...
 
enum  speed_limit_alert_result_data_type {
  SPEED_LIMIT_RESULT_SUCCESS = 0,
  SPEED_LIMIT_RESULT_ERROR = 1,
  SPEED_LIMIT_RESULT_MODE_UNSUPPORTED = 2
}
 Enum for speed limit alert result. More...
 
enum  stop_status_status_enum {
  INVALID_STOP_STATUS = INVALID16,
  REQUEST_STOP_STATUS = 0,
  REQUEST_MARK_STOP_DONE = 1,
  REQUEST_ACTIVATE_STOP = 2,
  REQUEST_DELETE_STOP = 3,
  REQUEST_MOVE_STOP = 4,
  STOP_STATUS_ACTIVE = 100,
  STOP_STATUS_DONE = 101,
  STOP_STATUS_UNREAD = 102,
  STOP_STATUS_READ = 103,
  STOP_STATUS_DELETED = 104
}
 
enum  txt_ack_type {
  OK_ACK = 0,
  YES_ACK = 1,
  NO_ACK = 2
}
 Enumeration for A602 ack text message responses. More...
 

Macro Definition Documentation

#define FMI_DRIVER_COUNT   ( 3 )

Number of supported drivers.

Since
Protocol A607

Definition at line 147 of file fmi.h.

Referenced by CDriverIdAndStatusDlg::OnInitDialog(), FmiApplicationLayer::procDriverStatusUpdate(), and FmiApplicationLayer::rx().

#define FMI_PROTOCOL_LEVEL   623

Definition at line 23 of file fmi.h.

Referenced by CFmiPcAppDlg::OnInitDialog().

#define FMI_SUPPORT_A602   ( FMI_PROTOCOL_LEVEL >= 602 )

If true, app was build with support for A602 protocols.

Definition at line 27 of file fmi.h.

#define FMI_SUPPORT_A603   ( FMI_PROTOCOL_LEVEL >= 603 )

If true, app was build with support for A603 protocols.

Definition at line 30 of file fmi.h.

#define FMI_SUPPORT_A604   ( FMI_PROTOCOL_LEVEL >= 604 )

If true, app was build with support for A604 protocols.

Definition at line 33 of file fmi.h.

Referenced by FmiApplicationLayer::onAck().

#define FMI_SUPPORT_A605   ( FMI_PROTOCOL_LEVEL >= 605 )

If true, app was build with support for A605 protocols.

Definition at line 36 of file fmi.h.

#define FMI_SUPPORT_A606   ( FMI_PROTOCOL_LEVEL >= 606 )

If true, app was build with support for A606 protocols.

Definition at line 39 of file fmi.h.

#define FMI_SUPPORT_A607   ( FMI_PROTOCOL_LEVEL >= 607 )

If true, app was build with support for A607 protocols.

Definition at line 42 of file fmi.h.

#define FMI_SUPPORT_A608   ( FMI_PROTOCOL_LEVEL >= 608 )

If true, app was build with support for A608 protocols.

Definition at line 48 of file fmi.h.

#define FMI_SUPPORT_A609   ( FMI_PROTOCOL_LEVEL >= 609 )

If true, app was build with support for A609 protocols.

Definition at line 51 of file fmi.h.

#define FMI_SUPPORT_A610   ( FMI_PROTOCOL_LEVEL >= 610 )

If true, app was build with support for A610(AOBRD) protocols.

Definition at line 54 of file fmi.h.

#define FMI_SUPPORT_A611   ( FMI_PROTOCOL_LEVEL >= 611 )

If true, app was built with support for A611 protocols.

Definition at line 57 of file fmi.h.

Referenced by CTxtMsgNewDlg::OnEnChangeEditFields().

#define FMI_SUPPORT_A612   ( FMI_PROTOCOL_LEVEL >= 612 )

If true, app was built with support for A612 protocols.

Definition at line 60 of file fmi.h.

#define FMI_SUPPORT_A613   ( FMI_PROTOCOL_LEVEL >= 613 )

If true, app was built with support for A613 protocols.

Definition at line 63 of file fmi.h.

#define FMI_SUPPORT_A614   ( FMI_PROTOCOL_LEVEL >= 614 )

If true, app was built with support for A614 protocols.

Definition at line 66 of file fmi.h.

#define FMI_SUPPORT_A615   ( FMI_PROTOCOL_LEVEL >= 615 )

If true, app was built with support for A615 protocols.

Definition at line 69 of file fmi.h.

Referenced by CAobrdDriversDlg::OnChangeDriverData().

#define FMI_SUPPORT_A616   ( FMI_PROTOCOL_LEVEL >= 616 )

If true, app was built with support for A616 protocols.

Definition at line 72 of file fmi.h.

#define FMI_SUPPORT_A617   ( FMI_PROTOCOL_LEVEL >= 617 )

If true, app was built with support for A617 protocols.

Definition at line 75 of file fmi.h.

#define FMI_SUPPORT_A618   ( FMI_PROTOCOL_LEVEL >= 618 )

If true, app was built with support for A618 protocols.

Definition at line 78 of file fmi.h.

#define FMI_SUPPORT_A619   ( FMI_PROTOCOL_LEVEL >= 619 )

If true, app was built with support for A619 protocols.

Definition at line 81 of file fmi.h.

#define FMI_SUPPORT_A620   ( FMI_PROTOCOL_LEVEL >= 620 )

If true, app was built with support for A620 protocols.

Definition at line 84 of file fmi.h.

#define FMI_SUPPORT_A621   ( FMI_PROTOCOL_LEVEL >= 621 )

If true, app was built with support for A621 protocols.

Definition at line 87 of file fmi.h.

#define FMI_SUPPORT_A622   ( FMI_PROTOCOL_LEVEL >= 622 )

If true, app was built with support for A622 protocols.

Definition at line 90 of file fmi.h.

#define FMI_SUPPORT_A623   ( FMI_PROTOCOL_LEVEL >= 623 )

If true, app was built with support for A622 protocols.

Definition at line 93 of file fmi.h.

#define FMI_SUPPORT_LEGACY   ( !FMI_SUPPORT_A607 )

If true, app was build with support for legacy protocols.

Definition at line 45 of file fmi.h.

#define INVALID16   0xFFFF

Placeholder for an invalid 16-bit value.

Definition at line 142 of file fmi.h.

Referenced by CStopListDlg::OnBnClickedSend(), FmiApplicationLayer::rx(), and FmiApplicationLayer::sendStopStatusRequest().

#define INVALID_LAT   0x7FFFFFFFL

placeholder for invalid latitude value

Definition at line 136 of file fmi.h.

Referenced by CDashcamNtfctnFromClient::init(), CTxtMsgFromClient::OnInitDialog(), and FmiApplicationLayer::rx().

#define LOG_SHOW_RAW_ASCII   ( TRUE )

If TRUE, interpret the raw packet as ASCII.

If TRUE, the log viewer shows the raw packet as ASCII as well as in hex; this may make it easier to understand a packet's content when it contains mostly text. However, individual fields are already parsed, and packets are usually binary data, so this has limited use. Setting this to TRUE may require the log viewer window to be resized to show all the data.

Definition at line 126 of file fmi.h.

#define LONG_TEXT_MSG_CHUNK_SIZE   ( 200 )

Maximum number of bytes in one segment of an A611 Long Text Message.

Definition at line 167 of file fmi.h.

Referenced by FmiApplicationLayer::beginA611LongTextMessage(), FmiApplicationLayer::rx(), and FmiApplicationLayer::sendCannedResponseTextMessage().

#define LONG_TEXT_MSG_MAX_SIZE   ( 2000 )

Maximum number of bytes in an A611 Long Text Message.

Definition at line 164 of file fmi.h.

Referenced by CTxtMsgNewDlg::OnBnClickedOk(), and CTxtMsgNewDlg::OnEnChangeEditFields().

#define MAX_THROTTLED_PROTOCOLS   60

Maximum number of protocols that can be throttled.

This limit is derived from the size of the message_throttling_list_data_type

Definition at line 132 of file fmi.h.

Referenced by FmiApplicationLayer::rx().

#define MINIMAL_ENABLE   ( FALSE )

If TRUE, the Enable is minimal.

If TRUE, the initial FMI enable process only consists of the Enable FMI protocol. PVT and auto-ETA are not enabled, the stop list is not refreshed, and the Unit ID/ESN Protocol and Product id and Support protocols are not performed.

Note
This should normally be FALSE. If setting this to TRUE to test a server that does not send any packets after the enable, also set UNICODE_ENABLED to FALSE.

Definition at line 116 of file fmi.h.

#define PROTOCOL_SIZE   ( MAX_PAYLOAD_SIZE / sizeof( protocol_support_data_type ) * 5 + 1 )

Size of the formatted "supported protocols" string.

5 characters are needed for each protocol_support_data_type, "Xnnn ", plus 1 character is needed for the null terminator.

Definition at line 157 of file fmi.h.

Referenced by CFmiPcAppDlg::OnEventProtocolsReceived().

#define SKIP_VALIDATION   ( FALSE )

If TRUE, no validation of inputs is performed in the UI.

Set this to FALSE for a server app that conforms to the FMI protocols. Set to TRUE to be allowed to perform certain operations that violate the Fleet Management Interface specification.

Definition at line 105 of file fmi.h.

#define TEXT_MSG_BUFFER_MAX_SIZE   LONG_TEXT_MSG_MAX_SIZE

The maximum size of any text message, in bytes.

Definition at line 172 of file fmi.h.

Referenced by CTxtMsgNewDlg::OnBnClickedOk().

#define TEXT_MSG_MAX_SIZE   ( 200 )

Maximum payload of a single text message, in bytes.

Definition at line 160 of file fmi.h.

Referenced by CTxtMsgNewDlg::OnBnClickedOk(), and CTxtMsgNewDlg::OnEnChangeEditFields().

#define UNICODE_ENABLED   ( TRUE )

If TRUE, the server supports Unicode.

Note
This should normally be TRUE

Definition at line 98 of file fmi.h.

Typedef Documentation

Garmin command ID (payload when packet ID == ID_COMMAND_BYTE)

See also
command_enum for supported values

Definition at line 260 of file fmi.h.

Definition at line 1045 of file fmi.h.

Definition at line 1046 of file fmi.h.

Fleet Management packet ID (first two bytes of payload when Garmin packet ID == ID_FMI_PACKET)

See also
fmi_packet_id_enum for supported values

Definition at line 272 of file fmi.h.

Type for new_state from the message_throttling_data_type.

Since
Protocol A604

Definition at line 914 of file fmi.h.

Enumeration for Stop Status protocol.

Since
Protocol A603

Definition at line 962 of file fmi.h.

Data type for the FMI_ID_WAYPOINT_DELETED packet.

Since
Protocol A607

Definition at line 1687 of file fmi.h.

Enumeration Type Documentation

Valid values for the message_type field of the A604_server_to_client_open_text_msg_data_type.

Since
Protocol A604
Enumerator
A604_MESSAGE_TYPE_NORMAL 
A604_MESSAGE_TYPE_DISP_IMMEDIATE 

Definition at line 886 of file fmi.h.

Enum for log status/shipment download packet receipt result code.

Since
Protocol A610
Enumerator
FMI_LOGIN_NO_ERRORS 
FMI_LOGIN_WRONG_ID_SERVER_RESPONSE 
FMI_LOGIN_INVALID_ID_SERVER_RESPONSE 
FMI_LOGIN_UNEXPECTED_RESPONSE_PACKET 
FMI_LOGIN_SHIPMENT_DB_ERROR 
FMI_LOGIN_ANNOTATION_DB_ERROR 

Definition at line 642 of file fmi.h.

Enum for shipment download packet content type.

Since
Protocol A610
Enumerator
CONTAINS_DATA 
EMPTY_DATA 
UNKNOWN_DRIVER 
UNSUPPORTED 

Definition at line 632 of file fmi.h.

Enum for supported time zone IDs.

Since
Protocol A610
Enumerator
EASTERN 
CENTRAL 
MOUNTAIN 
PACIFIC 
ALASKA 
HAWAII 
TIME_ZONE_COUNT 

Definition at line 654 of file fmi.h.

Enum for fmi_ack_type.

Since
Protocol A610
Enumerator
UPDATE_ACCEPT 
UPDATE_FAIL 
UPDATE_DECLINE 
UPDATE_NOT_READY 
UPDATE_NO_DATA 
UPDATE_STORAGE_ERROR 
UPDATE_RESULT_ERROR 
UPDATE_INTERFACE_ERROR 
NUM_OF_UPDATE_PROFILE_CODES 

Definition at line 667 of file fmi.h.

Enumeration for result_code from the canned_response_list packet.

Since
Protocol A604
Enumerator
CANNED_RESP_LIST_SUCCESS 
CANNED_RESP_LIST_INVALID_COUNT 
CANNED_RESP_LIST_INVALID_MSG_ID 
CANNED_RESP_LIST_DUPLICATE_MSG_ID 
CANNED_RESP_LIST_FULL 

Definition at line 903 of file fmi.h.

The code page used for encoding of text fields sent to or received from the client.

Since
Protocol A604 added UTF8 support.
Enumerator
CODEPAGE_ASCII 
CODEPAGE_UNICODE 

Definition at line 189 of file fmi.h.

Garmin command ID.

Enumerator
COMMAND_REQ_DATE_TIME 
COMMAND_REQ_UNIT_ID 
COMMAND_TURN_ON_PVT_DATA 
COMMAND_TURN_OFF_PVT_DATA 

Definition at line 262 of file fmi.h.

enum del_data

Enumeration for Data Deletion protocol.

Since
Protocol A603
Enumerator
DELETE_ALL_STOPS 
DELETE_ALL_MESSAGES 
DELETE_ACTIVE_ROUTE 
DELETE_CANNED_MESSAGES 
DELETE_CANNED_RESPONSES 
DELETE_GPI_FILE 
DELETE_DRIVER_ID_AND_STATUS 
DISABLE_FMI 
DELETE_WAYPOINTS 
DELETE_FORMS 
DELETE_CUSTOM_AVOIDANCES 
DELETE_SENSORS 

Definition at line 982 of file fmi.h.

Valid values for file transfer result.

Since
Protocol A604
Enumerator
FMI_FILE_RESULT_SUCCESS 
FMI_FILE_RESULT_CRC_ERROR 
FMI_FILE_RESULT_LOW_MEM 
FMI_FILE_RESULT_INVALID_FILE 
FMI_FILE_RESULT_NO_TRANSFER 
FMI_FILE_RESULT_SEVERE 
FMI_FILE_RESULT_INVALID_FILE_TYPE 
FMI_FILE_RESULT_INVALID_GPI_FILE 
FMI_FILE_START_OPEN_ERROR 
FMI_FILE_START_CLOSE_ERROR 
FMI_FILE_RESULT_FINALIZE_ERROR 
FMI_FILE_RESULT_NOT_PROCESSED 
FMI_FILE_RESULT_RX_GZIP_ERROR 
FMI_FILE_RESULT_BUSY 

Definition at line 927 of file fmi.h.

Valid values for file transfer types.

Since
Protocol A610
Enumerator
FMI_FILE_TYPE_GPI 
FMI_FILE_TYPE_AOBRD 
FMI_FILE_TYPE_CUSTOM_FORMS 
FMI_FILE_TYPE_PATH_SPECIFIC_ROUTE 
FMI_FILE_TYPE_IFTA 
FMI_FILE_TYPE_LONG_STOP 
FMI_FILE_TYPE_CNT 

Definition at line 608 of file fmi.h.

Enum for A604 message status protocol.

Since
Protocol A604
Enumerator
MESSAGE_STATUS_UNREAD 
MESSAGE_STATUS_READ 
MESSAGE_STATUS_NOT_FOUND 

Definition at line 894 of file fmi.h.

Enum for Alert Popup predefined icon numbers.

Since
Protocol A617
Enumerator
FMI_ALERT_ICON_NONE 
FMI_ALERT_ICON_DRIVER_BEHAVIOR 
FMI_ALERT_ICON_TIRE_PRESSURE 
FMI_ALERT_ICON_TEMPERATURE 
FMI_ALERT_ICON_DOOR_SENSOR 
FMI_ALERT_ICON_VEHICLE_MAINTENANCE 
FMI_ALERT_ICON_OBD2_GENERIC_SENSOR 
FMI_ALERT_ICON_GENERIC_SENSOR1 
FMI_ALERT_ICON_GENERIC_SENSOR2 
FMI_ALERT_ICON_GENERIC_SENSOR3 
FMI_ALERT_ICON_GENERAL_CONNECTIVITY 
FMI_ALERT_ICON_DAILY_HOURS_COUNTER 
FMI_ALERT_ICON_WEEKLY_HOURS_COUNTER 
FMI_ALERT_ICON_REST_HOURS_COUNTER 
FMI_ALERT_ICON_BREAK_HOURS_COUNTER 
FMI_ALERT_ICON_TASKS 
FMI_ALERT_ICON_WEIGHT 
FMI_ALERT_ICON_INFORMATION 
FMI_ALERT_ICON_FUEL 
FMI_ALERT_ICON_EU_AVAILABLE 
FMI_ALERT_ICON_EU_DRIVING 
FMI_ALERT_ICON_EU_REST 
FMI_ALERT_ICON_EU_WORK 
FMI_ALERT_ICON_RESERVED 

Definition at line 801 of file fmi.h.

Enum for Alert Popup receipt result code.

Since
Protocol A617
Enumerator
FMI_ALERT_POPUP_SUCCESS 
FMI_ALERT_TEXT_TOO_LONG 
FMI_ALERT_ICON_NUM_OUT_OF_RANGE 
FMI_ALERT_MISSING_ALERT_TEXT_AND_ICON 
FMI_ALERT_SEVERITY_OUT_OF_RANGE 
FMI_ALERT_TIMEOUT_OUT_OF_RANGE 

Definition at line 841 of file fmi.h.

Enum for Alert Popup predefined icon numbers.

Since
Protocol A617
Enumerator
FMI_ALERT_SEVERITY_NORMAL 
FMI_ALERT_SEVERITY_MEDIUM 
FMI_ALERT_SEVERITY_HIGH 

Definition at line 832 of file fmi.h.

Enum for Baud Rate code type.

Since
Protocol A616
Enumerator
FMI_BAUD_RATE_9600 
FMI_BAUD_RATE_38400 
FMI_BAUD_RATE_57600 

Definition at line 789 of file fmi.h.

Enum for Baud Rate request type.

Since
Protocol A616
Enumerator
FMI_BAUD_NEW_RATE_REQUEST 
FMI_BAUD_RATE_SYNC_REQUEST 

Definition at line 781 of file fmi.h.

Enum for Baud Rate receipt result code.

Since
Protocol A616
Enumerator
FMI_BAUD_RATE_OK 
FMI_BAUD_REQUEST_TYPE_SERVER_ERROR 
FMI_BAUD_RATE_SERVER_ERROR 
FMI_BAUD_RATE_CONTROL_IS_DISABLED 
FMI_BAUD_RATE_CLIENT_ERROR 
FMI_BAUD_SET_ERROR 
FMI_BAUD_PLUG_ID_ERROR 

Definition at line 768 of file fmi.h.

Enumerator
CUSTOM_AVOID_SUCCESS 
CUSTOM_AVOID_ID_NOT_FOUND 
CUSTOM_AVOID_ERR_FULL 
CUSTOM_AVOID_ERR_NV 
CUSTOM_AVOID_ERR_NM_INUSE 
CUSTOM_AVOID_ERR_FEAT_NOT_ENBL 
CUSTOM_AVOID_ERR_ID_OUT_OF_RANGE 

Definition at line 1032 of file fmi.h.

Enumerator
DASHCAM_INCIDENT_NTFCTN 
DASHCAM_FCW_NTFCTN 
DASHCAM_LDW_NTFCTN 

Definition at line 712 of file fmi.h.

Enumerator
DASHCAM_SUCCESS 
DASHCAM_ERR_LOCK_ADAS_FEATURE_NOT_SUPPORT 
DASHCAM_ERR_AFTER_POWER_LOSS_SETTINGS_OUT_OF_RANGE 
DASHCAM_ERR_RECORDER_RESOLUTION_OUT_OF_RANGE 
DASHCAM_ERR_FCWS_SENSITIVITY_OUT_OF_RANGE 
DASHCAM_ERR_SETTING_ID_OUT_OF_RANGE 
DASHCAM_ERR_INTERNAL 
DASHCAM_ERR_FCW_LDW_NTFCTN_NOT_SUPPORT 
DASHCAM_ERR_FCW_NOT_ENABLED 
DASHCAM_ERR_LDW_NOT_ENABLED 
DASHCAM_ERR_INCIDENT_NOT_ENABLED 

Definition at line 697 of file fmi.h.

Enumerator
DASHCAM_FORWARD_COLLISION 
DASHCAM_COLLISION_SENSITIVITY 
DASHCAM_LANE_DEPARTURE 
DASHCAM_RECORD_ON_STARTUP 
DASHCAM_INCIDENT_DETECTION 
DASHCAM_RECORD_AUDIO 
DASHCAM_DATA_OVERLAY_DATE_TIME 
DASHCAM_DATA_OVERLAY_LOCATION_SPEED 
DASHCAM_VIDEO_RESOLUTION 
DASHCAM_RECORD_AFTER_POWER_LOSS 

Definition at line 683 of file fmi.h.

Enumerator
ETA_SETTING_NONE 
ETA_SETTING_DISPATCH 
ETA_SETTING_DRIVER 
ETA_SETTING_DISPATCH_AND_DRIVER 

Definition at line 1047 of file fmi.h.

Enumerator
FMI_ETA_SETTING_SUCCESS 
FMI_ETA_SETTING_RANGE_ERROR 
FMI_ETA_SETTING_NV_FAILURE 

Definition at line 1054 of file fmi.h.

Valid values for the features field of the fmi_features_data_type.

Since
Protocol A607
Enumerator
FEATURE_ID_UNICODE 
FEATURE_ID_A607_SUPPORT 
FEATURE_ID_DRIVER_PASSWORDS 
FEATURE_ID_MULTIPLE_DRIVERS 
FEATURE_ID_AOBRD_SUPPORT 
FEATURE_STATE_ENABLED 
FEATURE_STATE_DISABLED 
FEATURE_ID_MASK 
FEATURE_STATE_MASK 

Definition at line 590 of file fmi.h.

Enumerator
LONG_TEXT_SUCCESS 
LONG_TEXT_INVALID_ID_SIZE 
LONG_TEXT_NON_ZERO_SEQ_NUM_ERROR 
LONG_TEXT_ID_IN_USE_SQL_ERROR 
LONG_TEXT_ID_IN_USE_ERROR 
LONG_TEXT_MALLOC_BUFFER_FAIL 
LONG_TEXT_WRONG_ID_SIZE 
LONG_TEXT_WRONG_ID_ERROR 
LONG_TEXT_NON_INC_SEQ_NUM_ERROR 
LONG_TEXT_WRONG_ORIG_TIME 
LONG_TEXT_WRONG_MESSAGE_TYPE 
LONG_TEXT_EXCEEDED_MAX_BYTES 
LONG_TEXT_APPEND_NULL_PTR 
LONG_TEXT_SAVE_SQL_NULL_PTR 
LONG_TEXT_MALLOC_INBOX_FAIL 
LONG_TEXT_SQL_INSERT_FAIL 

Definition at line 1010 of file fmi.h.

Fleet Management packet ID.

Enumerator
FMI_ID_ENABLE 
FMI_ID_PRODUCT_ID_SUPPORT_RQST 
FMI_ID_PRODUCT_ID_DATA 
FMI_ID_PROTOCOL_DATA 
FMI_ID_UNICODE_REQUEST 
FMI_ID_UNICODE_RESPONSE 
FMI_ID_TEXT_MSG_ACK 
FMI_ID_SERVER_OPEN_TXT_MSG 
FMI_ID_SERVER_OK_ACK_TXT_MSG 
FMI_ID_SERVER_YES_NO_CONFIRM_MSG 
FMI_ID_CLIENT_OPEN_TXT_MSG 
FMI_ID_CLIENT_TXT_MSG_RCPT 
FMI_ID_A607_CLIENT_OPEN_TXT_MSG 
FMI_ID_SET_CANNED_RESP_LIST 
FMI_ID_CANNED_RESP_LIST_RCPT 
FMI_ID_A604_OPEN_TEXT_MSG 
FMI_ID_A604_OPEN_TEXT_MSG_RCPT 
FMI_ID_TEXT_MSG_ACK_RCPT 
FMI_ID_TEXT_MSG_DELETE_REQUEST 
FMI_ID_TEXT_MSG_DELETE_RESPONSE 
FMI_ID_SET_CANNED_RESPONSE 
FMI_ID_DELETE_CANNED_RESPONSE 
FMI_ID_SET_CANNED_RESPONSE_RCPT 
FMI_ID_DELETE_CANNED_RESPONSE_RCPT 
FMI_ID_REFRESH_CANNED_RESP_LIST 
FMI_ID_TEXT_MSG_STATUS_REQUEST 
FMI_ID_TEXT_MSG_STATUS 
FMI_ID_SET_CANNED_MSG 
FMI_ID_SET_CANNED_MSG_RCPT 
FMI_ID_DELETE_CANNED_MSG 
FMI_ID_DELETE_CANNED_MSG_RCPT 
FMI_ID_REFRESH_CANNED_MSG_LIST 
FMI_ID_LONG_TEXT_MSG 
FMI_ID_LONG_TEXT_MSG_RCPT 
FMI_ID_A602_STOP 
FMI_ID_A603_STOP 
FMI_ID_SORT_STOP_LIST 
FMI_ID_SORT_STOP_LIST_ACK 
FMI_ID_WAYPOINT 
FMI_ID_WAYPOINT_RCPT 
FMI_ID_WAYPOINT_DELETE 
FMI_ID_WAYPOINT_DELETED 
FMI_ID_WAYPOINT_DELETED_RCPT 
FMI_ID_DELETE_WAYPOINT_CAT 
FMI_ID_DELETE_WAYPOINT_CAT_RCPT 
FMI_ID_CREATE_WAYPOINT_CAT 
FMI_ID_CREATE_WAYPOINT_CAT_RCPT 
FMI_ID_ETA_DATA_REQUEST 
FMI_ID_ETA_DATA 
FMI_ID_ETA_DATA_RCPT 
FMI_ID_STOP_STATUS_REQUEST 
FMI_ID_STOP_STATUS 
FMI_ID_STOP_STATUS_RCPT 
FMI_ID_AUTO_ARRIVAL 
FMI_ID_DATA_DELETION 
FMI_ID_USER_INTERFACE_TEXT 
FMI_ID_USER_INTERFACE_TEXT_RCPT 
FMI_ID_MSG_THROTTLING_COMMAND 
FMI_ID_MSG_THROTTLING_RESPONSE 
FMI_ID_MSG_THROTTLING_QUERY 
FMI_ID_MSG_THROTTLING_QUERY_RESPONSE 
FMI_ID_PING 
FMI_ID_PING_RESPONSE 
FMI_ID_FILE_TRANSFER_START 
FMI_ID_FILE_DATA_PACKET 
FMI_ID_FILE_TRANSFER_END 
FMI_ID_FILE_START_RCPT 
FMI_ID_FILE_PACKET_RCPT 
FMI_ID_FILE_END_RCPT 
FMI_ID_GPI_FILE_INFORMATION_REQUEST 
FMI_ID_GPI_FILE_INFORMATION 
FMI_ID_SET_DRIVER_STATUS_LIST_ITEM 
FMI_ID_DELETE_DRIVER_STATUS_LIST_ITEM 
FMI_ID_SET_DRIVER_STATUS_LIST_ITEM_RCPT 
FMI_ID_DEL_DRIVER_STATUS_LIST_ITEM_RCPT 
FMI_ID_DRIVER_STATUS_LIST_REFRESH 
FMI_ID_DRIVER_ID_REQUEST 
FMI_ID_DRIVER_ID_UPDATE 
FMI_ID_DRIVER_ID_RCPT 
FMI_ID_DRIVER_ID_UPDATE_D607 
FMI_ID_DRIVER_STATUS_REQUEST 
FMI_ID_DRIVER_STATUS_UPDATE 
FMI_ID_DRIVER_STATUS_RCPT 
FMI_ID_DRIVER_STATUS_UPDATE_D607 
FMI_SAFE_MODE 
FMI_SAFE_MODE_RESP 
FMI_SPEED_LIMIT_SET 
FMI_SPEED_LIMIT_RCPT 
FMI_SPEED_LIMIT_ALERT 
FMI_SPEED_LIMIT_ALERT_RCPT 
FMI_REBOOT_DEVICE_REQUEST 
FMI_SET_ODOMETER_REQUEST 
FMI_DRIVER_LOGIN_REQUEST 
FMI_DRIVER_LOGIN_RESPONSE 
FMI_DRIVER_PROFILE_DOWNLOAD_REQUEST 
FMI_DRIVER_PROFILE_DOWNLOAD_RESPONSE 
FMI_DRIVER_PROFILE_UPDATE 
FMI_DRIVER_STATUS_UPDATE_REQUEST 
FMI_DRIVER_STATUS_UPDATE_RESPONSE 
FMI_DRIVER_STATUS_UPDATE_RECEIPT 
FMI_DOWNLOAD_SHIPMENTS_REQUEST 
FMI_SHIPMENT_DOWNLOAD_RESPONSE 
FMI_SHIPMENT_DOWNLOAD_RECEIPT 
FMI_DRIVER_PROFILE_UPDATE_RESPONSE 
FMI_ANNOTATION_DOWNLOAD_REQUEST 
FMI_ANNOTATION_DOWNLOAD_RESPONSE 
FMI_ANNOTATION_DOWNLOAD_RECEIPT 
FMI_CUSTOM_FORM_DEL_REQUEST 
FMI_CUSTOM_FORM_DEL_RECEIPT 
FMI_CUSTOM_FORM_MOVE_REQUEST 
FMI_CUSTOM_FORM_MOVE_RECEIPT 
FMI_CUSTOM_FORM_GET_POS_REQUEST 
FMI_CUSTOM_FORM_GET_POS_RECEIPT 
FMI_CUSTOM_FORM_SHOW_REQUEST 
FMI_CUSTOM_FORM_SHOW_RECEIPT 
FMI_STOP_CALC_ACK_REQUEST 
FMI_STOP_CALC_ACK_RECEIPT 
FMI_CUSTOM_AVOID_ADD_REQUEST 
FMI_CUSTOM_AVOID_ADD_RECEIPT 
FMI_CUSTOM_AVOID_DEL_REQUEST 
FMI_CUSTOM_AVOID_DEL_RECEIPT 
FMI_CUSTOM_AVOID_TOGGLE_REQUEST 
FMI_CUSTOM_AVOID_TOGGLE_RECEIPT 
FMI_CUSTOM_AVOID_ENABLE_FEATURE_REQUEST 
FMI_CUSTOM_AVOID_ENABLE_FEATURE_RECEIPT 
FMI_IFTA_DATA_FETCH_REQUEST 
FMI_IFTA_DATA_FETCH_RECEIPT 
FMI_IFTA_DATA_DELETE_REQUEST 
FMI_IFTA_DATA_DELETE_RECEIPT 
FMI_DRIVER_PROFILE_UPDATE_V2 
FMI_DRIVER_PROFILE_DOWNLOAD_RESPONSE_V2 
FMI_HOS_AUTO_STATUS_FEATURE_REQUEST 
FMI_HOS_AUTO_STATUS_FEATURE_RECEIPT 
FMI_AOBRD_DRIVER_LOGOFF_REQUEST 
FMI_AOBRD_DRIVER_LOGOFF_RECEIPT 
FMI_HOS_8_HOUR_RULE_ENABLE_REQUEST 
FMI_HOS_8_HOUR_RULE_ENABLE_RECEIPT 
FMI_SET_BAUD_REQUEST 
FMI_SET_BAUD_RECEIPT 
FMI_ALERT_POPUP_REQUEST 
FMI_ALERT_POPUP_RECEIPT 
FMI_SENSOR_CONFIG_REQUEST 
FMI_SENSOR_CONFIG_RECEIPT 
FMI_SENSOR_DELETE_REQUEST 
FMI_SENSOR_DELETE_RECEIPT 
FMI_SENSOR_UPDATE_REQUEST 
FMI_SENSOR_QUERY_DISPLAY_INDEX_REQUEST 
FMI_SENSOR_QUERY_DISPLAY_INDEX_RECEIPT 
FMI_HOS_SET_SETTING_DATA_REQUEST 
FMI_HOS_SET_SETTING_DATA_RECEIPT 
FMI_DASHCAM_SETTINGS_LOCK_REQUEST 
FMI_DASHCAM_SETTINGS_LOCK_RECEIPT 
FMI_DASHCAM_CONFIG_REQUEST 
FMI_DASHCAM_CONFIG_RECEIPT 
FMI_DASHCAM_GET_SETTINGS_REQUEST 
FMI_DASHCAM_GET_SETTINGS_RESPONSE 
FMI_DASHCAM_SET_NTFCTN_REQUEST 
FMI_DASHCAM_SET_NTFCTN_RECEIPT 
FMI_DASHCAM_GET_NTFCTN_SETTINGS_REQUEST 
FMI_DASHCAM_GET_NTFCTN_SETTINGS_RESPONSE 
FMI_DASHCAM_NTFCTN_REQUEST 
FMI_DASHCAM_NTFCTN_RECEIPT 
FMI_DASHCAM_INCDNT_FILE_NTFCTN_REQUEST 
FMI_DASHCAM_INCDNT_FILE_NTFCTN_RECEIPT 
FMI_ID_ETA_MODE_REQUEST 
FMI_ID_ETA_MODE_RCPT 
FMI_ID_END 

Definition at line 275 of file fmi.h.

Enum for Sensor receipt result code.

Since
Protocol A617
Enumerator
FMI_SENSOR_SUCCESS 
FMI_SENSOR_ERR_NAME_TOO_LONG 
FMI_SENSOR_ERR_ICON_NUM_OUT_OF_RANGE 
FMI_SENSOR_ERR_MISSING_SENSOR_NAME 
FMI_SENSOR_ERR_SEVERITY_OUT_OF_RANGE 
FMI_SENSOR_ERR_STATUS_TOO_LONG 
FMI_SENSOR_ERR_DESCR_TOO_LONG 
FMI_SENSOR_ERR_TOO_MANY_SENSORS 
FMI_SENSOR_ERR_ID_NOT_FOUND 
FMI_SENSOR_ERR_DB 

Definition at line 853 of file fmi.h.

Possible values for pvt_data_type.type_of_gps_fix.

Enumerator
GPS_FIX_UNUSABLE 
GPS_FIX_INVALID 
GPS_FIX_2D 
GPS_FIX_3D 
GPS_FIX_2D_DIFF 
GPS_FIX_3D_DIFF 

Definition at line 1082 of file fmi.h.

Enum for HOS config setting type.

Since
Protocol A619
Enumerator
HOS_SETTING_AUTO_STATUS_STOP_MOVING_THRESHOLD_SECONDS 
HOS_SETTING_EIGHT_HOUR_RULE_ENABLE 
HOS_SETTING_PERIODIC_STATUS_PERIOD_SECONDS 
HOS_SETTING_START_TIME_OF_DAY 
HOS_SETTING_LAST 

Definition at line 872 of file fmi.h.

Enum for Auto Status Update result code.

Since
Protocol A615
Enumerator
FMI_HOS_SETTING_RESULT_OK 
FMI_HOS_SETTING_RESULT_SET_TO_MIN 
FMI_HOS_SETTING_RESULT_SET_TO_MAX 
FMI_HOS_SETTING_RESULT_FAIL 

Definition at line 755 of file fmi.h.

HOSART packet ID.

Enumerator
HOSART_CHANGE_STATUS 
HOSART_CHANGE_TO_DRIVING_WARNING 
HOSART_WARNING_FOUND 
HOSART_VIOLATION_FOUND 
HOSART_SET_PS_TO_OFF 

Definition at line 232 of file fmi.h.

Enumerator
HOS_RULES_LOAD_TYPE_PROPERTY 
HOS_RULES_LOAD_TYPE_PASSENGER 
NUM_HOS_RULES_LOAD_TYPE 

Definition at line 722 of file fmi.h.

enum id_enum

Garmin packet ID.

Enumerator
ID_COMMAND_BYTE 
ID_UNIT_ID 
ID_DATE_TIME_DATA 
ID_PVT_DATA 
ID_FMI_PACKET 
ID_HOSART_PACKET 
ID_SET_TIME_PACKET 
ID_PROTOCOL_ARRAY 
ID_PRODUCT_RQST 
ID_PRODUCT_DATA 

Definition at line 198 of file fmi.h.

Enum for IFTA file fetch receipt.

Since
Protocol A615
Enumerator
FMI_IFTA_OK 
FMI_IFTA_EXPORT_NO_DATA_FOUND 
FMI_IFTA_BUSY_ERROR 
FMI_IFTA_NULL_INPUT_PTR_ERROR 
FMI_IFTA_STATE_ERROR 
FMI_IFTA_MIN_DATA_SIZE_ERROR 
FMI_IFTA_MAX_DATA_SIZE_ERROR 
FMI_IFTA_MALLOC_ERROR 
FMI_IFTA_GZIP_ERROR 
FMI_IFTA_GFS_OPEN_ERROR 
FMI_IFTA_GFS_DIR_OPEN_ERROR 
FMI_IFTA_GFS_FSTAT_ERROR 
FMI_IFTA_GFS_READ_ERROR 
FMI_IFTA_GFS_REMOVE_ERROR 
FMI_IFTA_EXPORT_DATA_ERROR 
FMI_IFTA_DATA_GFS_WRITE_ERROR 
FMI_IFTA_TX_ERROR 

Definition at line 732 of file fmi.h.

Enumeration for new_state from the message_throttling_data_type.

Since
Protocol A604
Enumerator
MESSAGE_THROTTLE_STATE_DISABLE 
MESSAGE_THROTTLE_STATE_ENABLE 
MESSAGE_THROTTLE_STATE_ERROR 

Definition at line 918 of file fmi.h.

Enum for speed limit alert category.

Since
Protocol A608
Enumerator
SPEED_LIMIT_ALERT_BEGIN 
SPEED_LIMIT_ALERT_CHANGE 
SPEED_LIMIT_ALERT_END 
SPEED_LIMIT_ALERT_ERROR 
SPEED_LIMIT_ALERT_INVALID 

Definition at line 557 of file fmi.h.

Enum for speed limit alert mode.

Since
Protocol A608
Enumerator
SPEED_LIMIT_MODE_CAR 
SPEED_LIMIT_MODE_OFF 
SPEED_LIMIT_MODE_TRUCK 
SPEED_LIMIT_MODE_CNT 

Definition at line 577 of file fmi.h.

Enum for speed limit alert result.

Since
Protocol A608
Enumerator
SPEED_LIMIT_RESULT_SUCCESS 
SPEED_LIMIT_RESULT_ERROR 
SPEED_LIMIT_RESULT_MODE_UNSUPPORTED 

Definition at line 568 of file fmi.h.

Enumerator
INVALID_STOP_STATUS 
REQUEST_STOP_STATUS 
REQUEST_MARK_STOP_DONE 
REQUEST_ACTIVATE_STOP 
REQUEST_DELETE_STOP 
REQUEST_MOVE_STOP 
STOP_STATUS_ACTIVE 
STOP_STATUS_DONE 
STOP_STATUS_UNREAD 
STOP_STATUS_READ 
STOP_STATUS_DELETED 

Definition at line 963 of file fmi.h.

Enumeration for A602 ack text message responses.

Since
Protocol A602
Enumerator
OK_ACK 
YES_ACK 
NO_ACK 

Definition at line 951 of file fmi.h.