Routing

Msg_SetRoutingProfileJSON

This API accepts JSON input and will set the routing profile according to the attributes defined in the JSON. The following steps are the recommended way to modify a profile:

• If the profile does not exist:

  • Add a profile, sending in the name and vehicle type
  • CoPilot will create a new profile and return the properly formatted JSON representation of the routing profile. It will return it in the callback set with Msg_SetFlexCallback

• If the profile already exists:

  • Request the profile to get the proper JSON format, modify, and resend to CoPilot with Msg_SetRoutingProfileJSON
  • MSG_IDT_ADDROUTINGPROFILE and MSG_IDT_ROUTINGPROFILE_REQUEST for more detailed description on how to use those

For all of the matching identifiers please see Routing Profile Identifiers.

Syntax (Prototyped in alkmsg.h)

alkmsg.h
- long Msg_SetRoutingProfileJSON(const char* pJson);

alkmsg.cs
- public static extern int Msg_SetRoutingProfileJSON(byte[] pJson);

Parameters String jsonString - the routing profile in JSON format.

Return Value

Return Codes

Sample Code

The following code shows the steps needed to check, add, and change a Vehicle Routing Profile.

//Step 1: Check whether the profile exists
//For more information, please see: /copilot-navigation/sdk-app/api-functions/settings/#msg_idt_routingprofile_request

//Set the callback for error
Msg.delCallback delOnGenericData = new Msg.delCallback(OnGenericData);
Msg.Msg_UpdateOptions(Msg.MSG_ID_GenericData, true, false, delOnGenericData, Msg.callingConvention.convention_stdcall);

//Set the callback for successfully receiving a profile
Msg.delSDKDeliverCB delOnRoutingProfileResponseCB = new Msg.delSDKDeliverCB(OnRoutingProfileResponse);
Msg.Msg_SetFlexCallback(Util.ConvertString("TSdkRoutingProfileJsonRsp"), delOnRoutingProfileResponseCB);
string strProfileName = "Custom Heavy Duty";
Msg.Msg_SendGenericTextData(Msg.MSG_IDT_ROUTINGPROFILE_ACTION,
Msg.MSG_IDT_ROUTINGPROFILE_REQUEST,
Util.ConvertString(strProfileName),
strProfileName.Length, -1, -1, -1, false);

//Routing profile received if it already exists in CoPilot
private void OnRoutingProfileResponse(IntPtr pData, uint numBytes)
{
string sJson = Msg.MarshalNativeUTF8ToManagedString(pData);
}

//Callback will be called if profile could not be not be found
private void OnGenericData(uint pData, uint bytes)
{
int nIdentifier;
int nPayload;
Msg.Msg_GenericDataGet((uint)pData, out nIdentifier, out nPayload);
if (nIdentifier == Msg.MSG_IDT_ROUTINGPROFILEJSON_RESULT)
{
switch (nPayload)
{
case Msg.MSG_ROUTINGPROFILERESULT_FAILED_PROFILE_NOT_FOUND:
//Profile could not be found
break;
}
}
}

//Step 2: Add the routing profile
//For more information, please see: /copilot-navigation/sdk-app/api-functions/settings/#msg_idt_addroutingprofile

//Set the callback to check the result
Msg.delCallback delOnGenericData = new Msg.delCallback(OnGenericData);
Msg.Msg_UpdateOptions(Msg.MSG_ID_GenericData, true, false, delOnGenericData,
Msg.callingConvention.convention_stdcall);

//Set the callback to receive a routing profile if the request is successful
Msg.delSDKDeliverCB delOnRoutingProfileResponseCB = new Msg.delSDKDeliverCB(OnRoutingProfileResponse);
Msg.Msg_SetFlexCallback(Util.ConvertString("TSdkRoutingProfileJsonRsp"),
delOnRoutingProfileResponseCB);

//Set FlexCallback to receive the newly created routing profile
string strProfileName = "Custom Heavy Duty";
Msg.Msg_SendGenericTextData(Msg.MSG_IDT_ADDROUTINGPROFILE,
Msg.EVehicleType.VT_TruckHeavyDuty, //EVehicleType
Util.ConvertString(strProfileName),
strProfileName.Length, -1, -1, -1, false);

//Newly created routing profile successfully received.
private int OnRoutingProfileResponse(IntPtr pData, uint numBytes)
{
//JSON file for newly created profile
string strJson = Msg.MarshalNativeUTF8ToManagedString(pData);
}
//Callback will be called for success or error
private void OnGenericData(uint pData, uint bytes)
{
int nIdentifier;
int nPayload;
Msg.Msg_GenericDataGet((uint)pData, out nIdentifier, out nPayload);
if (nIdentifier == Msg.MSG_IDT_ROUTINGPROFILEJSON_RESULT)
{
switch (nPayload)
{
case Msg.MSG_ROUTINGPROFILERESULT_SUCCESS:
//Success
break;
//Rest are error codes. The following are a few examples.
case Msg.MSG_ROUTINGPROFILERESULT_FAIL:
break;
case Msg.MSG_ROUTINGPROFILERESULT_PARSE_JSON_FAIL:
break;
case Msg.MSG_ADDROUTINGPROFILERESULT_DUPLICATE_PROFILE_NAME_EXCEPTION:
break;
}
}
}

//Step 3: Change the profile received in either Step 1 or Step 2
//For more information, please see: /copilot-navigation/sdk-app/api-functions/routing/

//Set the callback for the result
Msg.delCallback delOnGenericData = new Msg.delCallback(OnGenericData);
Msg.Msg_UpdateOptions(Msg.MSG_ID_GenericData, true, false, delOnGenericData,
Msg.callingConvention.convention_stdcall);

//Set the routing profile
Msg.Msg_SetRoutingProfileJSON(strJsonProfile);

//Callback received for success or error
private void OnGenericData(uint pData, uint bytes)
{
int nIdentifier;
int nPayload;
Msg.Msg_GenericDataGet((uint)pData, out nIdentifier, out nPayload);
if (nIdentifier == Msg.MSG_IDT_ROUTINGPROFILEJSON_RESULT)
{
switch (nPayload)
{
case Msg.MSG_ROUTINGPROFILERESULT_SUCCESS:
break;
//Rest are error codes. The following are a few examples.
case Msg.MSG_ROUTINGPROFILERESULT_FAIL:
break;
case Msg.MSG_ROUTINGPROFILERESULT_PARSE_JSON_FAIL:
break;
case Msg.MSG_ADDROUTINGPROFILERESULT_DUPLICATE_PROFILE_NAME_EXCEPTION:
break;
}
}
}

//Step 4: Check whether or not profile is active in CoPilot
//For more information, please see: /copilot-navigation/sdk-app/api-functions/settings/#msg_idt_requestactiveprofile

// Set FlexCallback to receive the active routing profile
Msg.delSDKDeliverCB delOnRoutingProfileResponseCB = new Msg.delSDKDeliverCB(OnRoutingProfileResponse);
Msg.Msg_SetFlexCallback(Util.ConvertString("TSdkRoutingProfileJsonRsp"),
delOnRoutingProfileResponseCB);
Msg.Msg_SendGenericTextData(Msg.MSG_IDT_ROUTINGPROFILE_ACTION,
Msg.MSG_IDT_REQUESTACTIVEPROFILE,
(byte[])null,
0, -1, -1, -1, false);

//Receive the active profile
private int OnRoutingProfileResponse(IntPtr pData, uint numBytes)
{
string strJson = Msg.MarshalNativeUTF8ToManagedString(pData);

//Check the JSON to see whether the routing profile name is same one as you plan to set as active
}

//Step 5: If routing profile is not active, then set profile as an active profile in CoPilot
//For more information, please see: /copilot-navigation/sdk-app/api-functions/settings/#msg_idt_routingprofile_setasactive

//Set the callback for the result
Msg.delCallback delOnGenericData = new Msg.delCallback(OnGenericData);
Msg.Msg_UpdateOptions(Msg.MSG_ID_GenericData, true, false, delOnGenericData,
Msg.callingConvention.convention_stdcall);
string strProfileName = "Custom Heavy Duty";
Msg.Msg_SendGenericTextData(Msg.MSG_IDT_ROUTINGPROFILE_ACTION,
Msg.MSG_IDT_ROUTINGPROFILE_SETASACTIVE,
Util.ConvertString(strProfileName),
strProfileName.Length, -1, -1, -1,
false);
private void OnGenericData(uint pData, uint bytes)
{
int nIdentifier;
int nPayload;
Msg.Msg_GenericDataGet((uint)pData, out nIdentifier, out nPayload);
if (nIdentifier == Msg.MSG_IDT_ROUTINGPROFILEJSON_RESULT)
{
switch (nPayload)
{
case Msg.MSG_ROUTINGPROFILERESULT_SUCCESS:
//Active routing profile is set successfully
break;
//Rest are error codes. The following are a few examples.
case Msg.MSG_ROUTINGPROFILERESULT_FAIL:
//Error occurred when setting profile
break;
}
}
}

Example JSON

{
  "ProfileName": "Test1",
  "Region": "NA",
  "UserCreated": true,
  "RoutingProfileSource": 3,
  "ReadOnly": false,
  "Options": {
    "RouteType": 0,
    "VehicleType": 0,
    "HazType": 0,
    "BordersOpen": 1,
    "CongestionZonesOpen": 2,
    "LowEmissionZonesOpen": 2,
    "TollAvoid": 0,
    "NationalNetwork": 0,
    "53FootRouting": 0, // Deprecated in CoPilot 10.19.3.48. Use NationalNetwork
    "PropaneRestricted": 0,
    "Length": 0,
    "Width": 0,
    "Height": 0,
    "Weight": 0,
    "WeightPerAxle": 0,
    "TollClosed": 0,
    "FerryClosed": 0,
    "ElevationAvoid": 0,
    "ElevationAltitudeLimit": 7500,
    "GovernorSpeed": 0,
    "UltraLowEmissionZonesOpen": 2,
    "WrongSideOfStreetCostX1000": 500
  }
}

JSON Field Descriptions

The only two required fields are ProfileName and Region. Any value not passed in the JSON will be left as the value currently in CoPilot.

• "ProfileName" // Profile Name
• "Region" // Region Name
• "UserCreated" // Whether the profile is a default profile, or user created
• "RoutingProfileSource" //0 = Default, 1 = Manual, 2 = FleetPortal, 3 = API
• "ReadOnly"
• "Options": {
  • "RouteType" // Integer representation of RoutingType {RTE_Quickest = 0; RTE_Shortest = 1; RTEFastest = 3 (_Requires ActiveTraffic license)}
  • "VehicleType" // Integer representation of EVehicleType
  • "HazType" // Integer representation of THazType or a integer value returned by setHazmatTypeField that represents both the Hazmat Type and the EU Tunnel Code in Europe.
  • "BordersOpen" // Do (0) or do not (1, default) try to avoid border crossings
  • "CongestionZonesOpen" // {Avoid = 0, Allow = 1, Warn = 2} when route will enter a Congestion Zone. Default is Warn (2).
  • "LowEmissionZonesOpen" // {Avoid = 0, Allow = 1, Warn = 2} when route will enter a Low Emission Zone. Default is Warn (2).
  • "TollAvoid" // 1 = Route will avoid tolls if practical. (Set to 0 if using TollClosed.)
  • "NationalNetwork" // 1 = Use National Network preference for routing. Off (0) by default. (U.S. Only)
  • "53FootRouting" // 1 = // Deprecated in CoPilot 10.19.3.48. Use NationalNetwork. Off (0) by default. _(U.S. Only)
  • "PropaneRestricted" // 1 = Avoid Propane Restricted Roads. Off (0) by default. (U.S. Only)
  • "Length" // Truck Length in Hundredths of an inch
  • "Width" // Truck Height in Hundredths of an inch
  • "Height" // Truck width in Hundredths of an inch
  • "Weight" // Truck weight in tens of pounds
  • "WeightPerAxle" // Truck weight per axle in tens of pounds
  • "TollClosed" // 1 = Route will always avoid tolls (TollAvoid should = 0)
  • "FerryClosed" // 1 = Avoid Ferries
  • "ElevationAvoid" // 1 = Avoid Roads above the ElevationAltitudeLimit requires NA18Q3 or later data
  • "ElevationAltitudeLimit" // Threshold for Elevation avoid in feet requires NA18Q3 or later data
  • "GovernorSpeed" // Set a governor speed - 0 = off, which is the default. To apply a governor speed to ETA calculations, pass the speed in multiples of 1000. That is, to set the speed as 60 mph, you need to pass 60000 as the value.
  • "UltraLowEmissionZonesOpen" // {Avoid = 0, Allow = 1, Warn = 2} when route will enter an Ultra Low Emission Zone. Default is Warn (2).
  • "WrongSideOfStreetCostX1000"Available in CoPilot 10.14.0.325 or later // // Integer representation of EStreetAdherenceCost. Allows you to set the side of street adherence cost for a routing profile. Side of street adherence defines the extent to which CoPilot will try to route to the side of the street where a stop is located.

setHazmatTypeField and parseHazTypeField

To generate hazardous materials routing, the “HazType” field must be set in Msg_SetRoutingProfileJSON. That field holds an integer value that either represents the Hazmat Type for that profile or both the Hazmat Type and the EU Tunnel Code for hazardous materials routing in Europe.

setHazmatTypeField is a helper function that creates an integer value to represent both the Hazmat Type and the EU Tunnel Code. If the EU Tunnel Code is already set, you can parse the JSON to get the HazType value, and use the helper function parseHazTypeField to decode the Hazmat Type and EU Tunnel Code.

Syntax (Prototyped in alkmsg.h or alkmsg.java)

static unsigned long setHazmatTypeField(THazType hazType, TEUTunnelCode euTunnelCode);
static void parseHazTypeField(unsigned long ulHazType, THazType& hazType, TEUTunnelCode& euTunnelCode);

static public ulong setHazmatTypeField(THazType hazType, TEUTunnelCode euTunnelCode)
static public void parseHazTypeField(ulong ulHazType, out THazType hazType, out TEUTunnelCode euTunnelCode)

public static int setHazmatTypeField(THazType hazType, TEUTunnelCode euTunnelCode);
public static void parseHazTypeField(int ulHazType, THazType[] hazType, TEUTunnelCode[] euTunnelCode)

Parameters

THazType hazType - Hazardous Type that reflects the THazType enumerations. TEUTunnelCode euTunnel Code - Tunnel code type that reflects the TEUTunnelCode enumerations.

Return Value

The integer value that should be inserted into the RoutingProfile JSON field “HazType” to reflect the desired Hazmat Type and EU Tunnel Code pair.

Sample Code

//To create an integer value that represents an "Explosive" Hazmat Type and "CDE" Tunnel Code.

Msg.THazType hazType = HazType_Explosive;
Msg.TEUTunnelCode euTunnelCode = TEUTunnelCode.CDE;
ulong jsonHazTypeFieldValue = Msg.setHazmatTypeField(hazType, euTunnelCode);

//You would then set your JSON value of “HazType” to this value and use Msg_SetRoutingProfileJSON to set the routing profile

//This sample takes the parsed value of the HazType field from a JSON formatted Routing Profile

ulong ulHazType = Convert.ToUInt64((hazTypeFieldValue));
Msg.TEUTunnelCode euTunnelCode;
Msg.THazType hazType;
Msg.parseHazTypeField(ulHazType, out hazType, out euTunnelCode);

EStreetAdherenceCost

Enum used to set the side of street adherence cost for a routing profile with the Msg_SetRoutingProfileJSON API call.

TEUTunnelCode

Enum used to select a EU Tunnel Code for hazmat routing in Europe.

Values

THazType

Enum used to select a hazmat type for a Truck Heavy Duty or Truck Medium Duty profile.

Values

EVehicleType

Enum used to allow user to send an integer representation of a vehicle type. This is currently used in routing profiles and road speed sets

Values

RoadSpeedSet

Object representing a set of road speeds. This object contains a region and a vehicle type, as well as individual speeds for urban / rural roads of types interstate, divided highway, primary, secondary, local, ferry and ramp.

Note: Methods exist in C# alkmsg.cs, C++, and Java simply use the structure. C# public methods are to help transition from unmanaged structure to managed C# structure

Syntax (Prototyped in alkmsg.h)

Methods

Sample Code

private void OnRoadSpeedSetResponse(uint pData, uint bytes)
{
  uint uiNumSets = bytes / 260;
  IntPtr tmpRoadSpeedSetPtr = new IntPtr(pData);
  delListUpdate = new AddListItem(additem);
  if (uiNumSets > 1)
  {
    for (int i = 0; i < uiNumSets; i++)
    {
      if (i != 0)
      tmpRoadSpeedSetPtr = new IntPtr(tmpRoadSpeedSetPtr.ToInt64() + 260);
      Msg.RoadSpeedSet tmpRoadSpeedSet = new Msg.RoadSpeedSet(tmpRoadSpeedSetPtr);
      BeginInvoke(delListUpdate, new object[] { tmpRoadSpeedSet.jurisdiction });
    }
  }
  else if (uiNumSets == 1)
  {
    setRoadSpeed = new Msg.RoadSpeedSet(tmpRoadSpeedSetPtr);
    BeginInvoke(delRoadSpeedsUpdate, setRoadSpeed);
  }
  else
  {
    BeginInvoke(delStatusUpdate, "Error: Road Speed Set Request : Returned 0 Sets");
  }
}

Msg_AddRoadSpeedSetCallback

API to set a callback function that will receive the RoadSpeed set once a user calls Msg_RequestRoadSpeedSet

Syntax (Prototyped in alkmsg.h)

Alkmsg.h
  int Msg_AddRoadSpeedSetCallback(void* fnProcessMsg, callingConvention convention = convention_default);

alkmsg.cs
  public static extern int Msg_AddRoadSpeedSetCallback(delCallback fnDel, Msg.callingConvention convention);

Parameters void * fnProcessMsg - a pointer to the function that will receive the roadspeedset.

Return Value

Sample Code

delStatusUpdate = new StatusUpdate(statusUpdate);
  delRoadSpeedsUpdate = new SpeedTabUpdate(updateSpeedTab);
  btnRequestRoadSpeeds.Enabled = false;
  cmbVehType.SelectedIndex = 0;
  cmbSpeedSetType.SelectedIndex = 0;
  Msg.EVehicleType selectedVehicleType = ConvertVehicleTypeDropBoxIndexToVehicleType();
  int selSSTIdx = cmbSpeedSetType.SelectedIndex;
  //Version Specific Map Updates
  if (delOnRoadSpeedSetResponse == null)
  {
    delOnRoadSpeedSetResponse = new Msg.delCallback(OnRoadSpeedSetResponse);
    Msg.Msg_AddRoadSpeedSetCallback(delOnRoadSpeedSetResponse, Msg.callingConvention.convention_stdcall);
  }
  Msg.Msg_RequestRoadSpeedSet((int)selectedVehicleType, selSSTIdx, Util.ConvertString(""));

Msg_RequestRoadSpeedSet

This API requests the road speed that are currently set for a specified vehicle type, road area (Urban or Rural) and jurisdiction.

Syntax (Prototyped in alkmsg.h)

Alkmsg.h
    long Msg_RequestRoadSpeedSet(int iVehType, int iRoadArea, const char *pJurisdiction = 0);

alkmsg.cs
public static extern int Msg_RequestRoadSpeedSet(int ulVehType, int ulRoadArea, byte[] pJurisdiction);

Parameters

Return Value

Sample Code

   delStatusUpdate = new StatusUpdate(statusUpdate);
    delRoadSpeedsUpdate = new SpeedTabUpdate(updateSpeedTab);
    btnRequestRoadSpeeds.Enabled = false;
    cmbVehType.SelectedIndex = 0;
    cmbSpeedSetType.SelectedIndex = 0;
    Msg.EVehicleType selectedVehicleType = ConvertVehicleTypeDropBoxIndexToVehicleType();
    int selSSTIdx = cmbSpeedSetType.SelectedIndex;

    if (delOnRoadSpeedSetResponse == null)
     {
      delOnRoadSpeedSetResponse = new Msg.delCallback(OnRoadSpeedSetResponse);
      Msg.Msg_AddRoadSpeedSetCallback(delOnRoadSpeedSetResponse, Msg.callingConvention.convention_stdcall);
     }
    Msg.Msg_RequestRoadSpeedSet((int)selectedVehicleType, selSSTIdx, Util.ConvertString(""));```

Msg_SetRoadSpeedSet

This API allows for the setting of custom road speeds within CoPilot. Road Speeds are stored within CoPilot against each vehicle type and jurisdiction.

Syntax (Prototyped in alkmsg.h)

Alkmsg.h
    long Msg_SetRoadSpeedSet(void *pBytes, unsigned long byteLen);

alkmsg.cs
  public static extern int Msg_SetRoadSpeedSet(byte[] pBytes, uint bytes);

Return Value

Sample Code

private void btnSetRoadSpeedSet_Click(object sender, EventArgs e)
{
  Msg.Msg_SetRoadSpeedSet(setRoadSpeed.Data(), 260);
}

Msg_ResetRoadSpeedSetToDefault

Reset custom road speeds that were specified in CoPilot. By default, no custom road speeds are specified unless they were changed by the user via API. Custom road speeds can only be set via API, not the CoPilot UI from 10.9.0.

Syntax (Prototyped in alkmsg.h)

Alkmsg.h
  long Msg_ResetRoadSpeedSetToDefault(int iVehType, const char *pJurisdiction = 0);

Alkmsg.cs
  public static extern int Msg_ResetRoadSpeedSetToDefault(int ulVehType, byte[] pJurisdiction);

Parameters

int iVehType - integer representation of EVehicleType
const char *pJurisdiction - Jurisdiction to be reset, NULL indicates reset all

Return Value

Sample Code

private void btnResetJurRdSpds_Click(object sender, EventArgs e)
{
  Msg.EVehicleType selectedVehType = ConvertVehicleTypeDropBoxIndexToVehicleType();
  int selSSTIdx = cmbSpeedSetType.SelectedIndex;
  string tmpString = lstJurisdictions.Text;
  Msg.Msg_ResetRoadSpeedSetToDefault((int)selectedVehType, Util.ConvertString(lstJurisdictions.Text));
}

Msg_SendRoutingProfile

Sends an updated customized auto routing profile to CoPilot and sets it for all future trips to be run. The routing profile includes avoid and favor road categories as well as average road speeds for each road category.

Syntax (Prototyped in alkmsg.h)

long Msg_SendRoutingProfile(long lBreakMinute,
   long lBreakWaitMinute,
   long lVehicleType,
   long lRoutingType,
   unsigned short usPropaneRestr,
   unsigned short usIntBordersOpen,
   long lLondonCongZone,
   long lTollRoads,
   long lAvoidRtFrwy,
   long lSpeedFrwy,
   long lAvoidRtDivHwy,
   long lSpeedDivHwy,
   long lAvoidRtPriHwy,
   long lSpeedPriHwy,
   long lAvoidSecRd,
   long lSpeedSecRd,
   long lAvoidLclSt,
   long lSpeedLclSt,
   long lDestID = CONN_ID_NONE,
   long lSrcID = CONN_ID_NONE);

Parameters

Note: The profile gets saved in the “Save” folder as a flat file. The filenames are “ALKAuto_trip.dat” and “ALKAuto_stop.dat” for routing profiles for the vehicle type of VEH_Auto, and “ALKRV_trip.dat” and “ALKRV_stop.dat” for the vehicle type of VEH_RV.

Enums

enum VehicleType { VEH_Auto = 0, VEH_RV };
enum RoutingType {
  RTE_Quickest = 0,
  RTE_Shortest,
  RTE_AvoidMajorRoads,
  RTE_Scenic
};
enum TCZOpts { CZ_Avoid = 0, CZ_Allow, CZ_Warn };
enum TollRoads {
  TR_AlwaysAvoid = 0,
  TR_IfNecessary,
  TR_NoRestriction
};
enum AvoidRouting {
  AV_StrongAvoid = 0,
  AV_Avoid,
  AV_Neutral,
  AV_Favor,
  AV_StrongFavor
};

Return Value

• Less than or equal to 0 = Failed
• Greater than 0 = Successful

Msg_RequestRoutingProfile

Requests the information on a current routing profile. The routing profile includes avoid and favor road categories as well as average road speeds for each road category.

Syntax (Prototyped in alkmsg.h)

long Msg_RequestRoutingProfile(long lDestID = CONN_ID_NONE,
                               long lSrcID = CONN_ID_NONE););

Parameters

Return Value

• Less than 0 = Failed to send message to CoPilot
• 0 = Unable to send message as SDK didn’t find connections
• Greater than 0 = Successful

Msg_RoutingProfileGet

Retrieves and decodes routing information from Msg_ID_RoutingProfile message. To be used in conjunction with Msg_RequestRoutingProfile. The routing profile includes avoid and favor road categories as well as average road speeds for each road category.

Syntax (Prototyped in alkmsg.h)

long Msg_RoutingProfileGet(void *pBuffer,
                           long &rBreakMinute,
                           long &rBreakWaitMinute,
                           long &rVehicleType,
                           long &rRoutingType,
                           unsigned short &usPropanRestr,
                           unsigned short &usIntBordersOpen,
                           long &rLondonCongZone,
                           long &rTollRoads,
                           long &rAvoidRtFrwy,
                           long &rSpeedFrwy,
                           long &rAvoidRtDivHwy,
                           long &rSpeedDivHwy,
                           long &rAvoidRtPriHwy,
                           long &rSpeedPriHwy,
                           long &rAvoidSecRd,
                           long &rSpeedSecRd,
                           long &rAvoidLclSt,
                           long &rSpeedLclSt);

Parameters

Return Value

• 0 - Invalid buffer pointer
• 1 - Successful

lIdentifier

#define Msg_ID_RoutingProfile 0xf1000285

Enums

enum VehicleType { VEH_Auto = 0, VEH_RV };
enum RoutingType {
  RTE_Quickest = 0,
  RTE_Shortest,
  RTE_AvoidMajorRoads,
  RTE_Scenic
};

enum TCZOpts { CZ_Avoid = 0, CZ_Allow, CZ_Warn };
enum TollRoads {
  TR_AlwaysAvoid = 0,
  TR_IfNecessary,
  TR_NoRestriction
};

enum AvoidRouting {
  AV_StrongAvoid = 0,
  AV_Avoid,
  AV_Neutral,
  AV_Favor,
  AV_StrongFavor
};

Msg_SendTruckRoutingProfileEx

Sends a customized truck routing profile to CoPilot and sets it for all future trips to be run. It is used to provide vehicle heights, weights, widths etc, as well as Hazmat materials. Also average road speeds and avoid / favor road categories can be set.

Syntax (Prototyped in alkmsg.h)

long Msg_SendTruckRoutingProfileEx(long lBreakMinute,
   long lBreakWaitMinute,
   long lRoutingType,
   long usIntBordersOpen,
   long lTollRoads,
   unsigned short usOvrdTruckRestr,
   unsigned short usNatlNetwork,
   unsigned short us53ftTrailer,
   unsigned short usHazmatRt,
   long lHazType,
   long lAvoidRtFrwy,
   long lSpeedFrwy,
   long lAvoidRtDivHwy,
   long lSpeedDivHwy,
   long lAvoidRtPriHwy,
   long lSpeedPriHwy,
   long lAvoidSecRd,
   long lSpeedSecRd,
   long lAvoidLclSt,
   long lSpeedLclSt,
   long lLengthRestr,
   long lWidthRestr,
   long lHeightRestr,
   long lWeightRestr,
   long lWeightPerAxleRestr,
   long lLondonCongZone,
   long lLowEmissionZone,
   long lDestID = CONN_ID_NONE,
   long lSrcID = CONN_ID_NONE);

Parameters

All parameters is same as Msg_SendRoutingProfile. Msg_SendTruckRoutingProfileEx adds these three parameters

• lWeightPerAxleRestr
• lLondonCongZone,
• lLowEmissionZone

Note: The WeightPerAxle values can be converted via the helper function which are included in demo.cs.

For CoPilotV9 ‘Scenic’ and ‘avoid highways’ are not supported.

Test Data:

For a truck length of 16.5m (approx. 649 inches), our input for lLengthRestr is 6490 (649 * 10). The same logic applies for lHeightRestr and lWidthRestr.

For a truck length of 40ft (approx. 480 inches), our input for lLengthRestr is 4800 (480 * 10). The same logic applies for lHeightRestr and lWidthRestr.

For a truck weight of 8 tonnes (approx. 17640 lbs), our input for lWeightRestr is 1764 (17640 / 10). The same logic applies for lWeightPerAxleRestr.

Return Value

• Less than or equal to 0 = Failed
• Greater than 0 = Successful

Msg_RequestTruckRoutingProfileEx

Requests the current customized truck routing profile from CoPilot. To request vehicle heights, weights, widths etc, as well as Hazmat materials. Also average road speeds and avoid / favor road categories can be retrieved. Needs to be followed by Msg_TruckRoutingProfileGetEx to retrieve the responses.

Syntax (Prototyped in alkmsg.h)

long Msg_RequestTruckRoutingProfileEx(long lDestID = CONN_ID_NONE,
                                      long lSrcID = CONN_ID_NONE);

Parameters

Same as Msg_RequestTruckRoutingProfile

Return Value

• Less than 0 = Failed to send message to the CoPilot.
• 0 = Unable to send message as SDK didn’t find connection.
• Greater than 0 = Successful

Msg_TruckRoutingProfileGetEx

Following Msg_RequestTruckRoutingProfileEx retrieves and decodes routing information from Msg_ID_TruckRoutingProfile message.

Syntax (Prototyped in alkmsg.h)

long Msg_TruckRoutingProfileGetEx(void *pBuffer,
   long &rBreakMinute,
   long rBreakWaitMinute,
   long &rRoutingType,
   long &rIntBordersOpen,
   long &rTollRoads,
   unsigned short &usOvrdTruckRestr,
   unsigned short &usNatlNetwork,
   unsigned short &us53ftTrailer,
   unsigned short &usHazmatRt,
   long &rHazType,
   long &rAvoidRtFrwy,
   long &rSpeedFrwy,
   long &rAvoidRtDivHwy,
   long &rSpeedDivHwy,
   long &rAvoidRtPriHwy,
   long &rSpeedPriHwy,
   long &rAvoidSecRd,
   long &rSpeedSecRd,
   long &rAvoidLclSt,
   long &rSpeedLclSt,
   long &rLengthRestr,
   long &rWidthRestr,
   long &rHeightRestr,
   long &WeightRestr,
   long &lWeightPerAxleRestr,
   long &lLondonCongZone,
   long &lLowEmissionZone);

Parameters

All parameters is same as Msg_SendRoutingProfile except the following

• lWeightPerAxleRestr:

• lLondonCongZone,

• lLowEmissionZone

Return Value

• 0 Invalid buffer pointer

• 1 Successful

lIdentifier

#define Msg_ID_TruckRoutingProfileEx 0xf1000213

Msg_GetTruckAlert

Truck alerts are provided to inform the drivers of hazards on the road ahead, including sharp curves, steep hills, cross winds etc. Use this to receive these alerts via the client application as it decodes truck alert message from the message buffer received through subscription of Msg_ID_TruckAlert.

Syntax (Prototyped in alkmsg.h)

long Msg_GetTruckAlert (void *pBuffer,
                        unsigned long lBufLen,
                        unsigned long &rAlertType,
                        unsigned long &rAlertDistance);

Parameters

Return Value

• 0 - Buffer is not intended for Msg_ID_TruckAlert

• 1 - Successful

lIdentifier

#define Msg_ID_TruckAlert                              0xF100032E
#define TypeID_NoTruckOvertaking                       0
#define TypeID_Legal_RDM_No_UTurn                      1990
#define TypeID_Legal_RDM_No_Left                       1988
#define TypeID_Legal_RDM_No_Right                      1989
#define TypeID_Protected_Overtaking_ExtraLane          1992
#define TypeID_Protected_Overtaking_ExtraLaneRightSide 1993
#define TypeID_Protected_Overtaking_ExtraLaneLeftSide  1994
#define TypeID_RoadNarrows                             1987
#define TypeID_SharpCurveLeft                          1977
#define TypeID_SharpCurveRight                         1978
#define TypeID_SteepHillUpwards                        1982
#define TypeID_SteepHillDownwards                      1981
#define TypeID_LateralWind                             1985
#define TypeID_RiskOfGrounding                         1983
#define TypeID_TreeOverhang                            1986
#define TypeID_TruckPetrolStation                      1979
#define TypeID_TruckRestaurant                         1991

(The following alerts are available in Europe Only)

Alert Type	Description	Image
0	No Overtaking
1990	No UTurn
1992	Protected Overtaking ExtraLane
1993	Protected Overtaking ExtraLaneRight
1994	Protected Overtaking ExtraLaneLeft
1995	Lane Merge Right
1996	Lane Merge Left
1997	Lane Merge Center
1998	Railway Crossing Protected
1999	Railway Crossing Unprotected
1987	Road Narrows
1988	No Left Turn
1989	No Right Turn
1978	Sharp Curve Left
1977	Sharp Curve Right
1982	SteepHill Upwards
1981	SteepHill Downwards
1985	Lateral Wind
1983	Risk Of Grounding
1980	Accident Hazard
1986	Tree Overhang
1979	Truck Petrol Station

Note

Following configuration file is used to enable/disable truck alert:

copilot user.cfg

[TruckWarnings]
“Enabled”= 1/0

• If 1, it will display Truck alert in CoPilot. If Msg_ID_TruckAlerts are subscribed then it will provide real-time truck alerts to the SDK.

• If 0, it will not display Truck alert in CoPilot. Subscription of Msg_ID_TruckAlerts will not be available.

“TruckAlertsToSDKOnly”=1/0

• If 1, it will not display Truck alert in CoPilot.

• If 0, it will display Truck alert in CoPilot assumed that “Enabled” flag is 1.

Example

Msg_Subscribe(MSG_ID_TruckAlert);

Msg_UpdateOptions (MSG_ID_TruckAlert, true, false, TruckAlertCallback);

// Receiving side either by callback or through message queue mechanism
void TruckAlertCallback (const char *pBuf,const unsigned long lBufLen) {
  long lAlertType;
  long lAlertDistance
  Msg_GetTruckAlert(pBuf, lBuflen, lAlertType, lAlertDistance);
}

Note: lAlertDistance is in yards or meters (depending on user settings miles or km). If no alerts are received from CoPilot, the client application should clear the last alert displayed in 3.5 seconds. Please see sample application for implementation of TruckAlert.

Msg_GetRoutingEvent

Provides event based routing information through subscription of Msg_ID_RoutingEvent. The routing information includes, Route Calculation Progress, destination reached event, GPS signal loss, waypoint passed, destination changed event, restricted road event.

Note: Routing events are divided into different categories to allow the client application to control the notifications that are received. By default the config values for GPSRoutingEvent and TripRoutingEvent are set to = 0 and disabled. By default Restricted RoutingEvents is enabled and set to 1. The default config settings may differ depending on the version of CoPilot that you are running. A breakdown is provided below of the link between the identifiers and the config setting.

To enable the messages, each of the config values noted below should be set to = 1.

> [SDK] <br>
> "GPSRoutingEvent" = 0/1

• MSG_IDT_GPS_NOSIGNAL
• MSG_IDT_GPS_SEARCHING
• MSG_IDT_GPS_DETERMINING_POS
• MSG_IDT_GPS_SIGNALBACK

> [SDK] <br>
> "TripRoutingEvent"=0/1

• MSG_IDT_ROUTECALC_START

• MSG_IDT_ROUTECALC_PROGRESS

• MSG_IDT_ROUTECALC_END

• MSG_IDT_ROUTE_CALCFAILED

• MSG_IDT_ALTERNATE_ROUTECALC_START

• MSG_IDT_ALTERNATE_ROUTECALC_END

• MSG_IDT_DESTINATION_REACHED

• MSG_IDT_WAYPOINT_PASSED

• MSG_IDT_TRIP_NOSTOP

• MSG_IDT_TRIP_CHANGED

• MSG_IDT_DISTUNIT_CHANGED

• MSG_IDT_ROUTE_SYNC_MISMATCH

• MSG_IDT_ROUTE_SYNC_CALC_FINISHED

• MSG_ID_ROUTESYNCPOINTSOFF

• MSG_IDT_TRAFFIC_DELAY

[SDK]
“RestrictedRoutingEvent” = 0/1

• MSG_IDT_ROUTE_RESTRICTEDROAD
• MSG_IDT_ROUTE_RESTRICTEDDEST
• MSG_IDT_RESTRICTED_ROAD

Syntax (Prototyped in alkmsg.h)

long Msg_GetRoutingEvent (void *pBuffer,
   unsigned long lBufLen,
   unsigned long &rEventType,
   long &rPayload);

Parameters

Return Value

• 0 Buffer is not intended for Msg_ID_RoutingEvent.
• 1 Successful

lIdentifier

#define Msg_ID_RoutingEvent 0xf1000126

Msg_IDT_ROUTECALC_START

Route calculation started.

#define Msg_IDT_ROUTECALC_START 0x0001L

Msg_IDT_ROUTECALC_PROGRESS

Route calculation is in progress.

#define Msg_IDT_ROUTECALC_PROGRESS 0x0002L

Msg_IDT_ROUTECALC_END

Route calculation finished.

#define Msg_IDT_ROUTECALC_END 0x0003L

Msg_IDT_DESTINATION_REACHED

User reached to destination.

#define Msg_IDT_DESTINATION_REACHED 0x0004L

Msg_IDT_GPS_NOSIGNAL

CoPilot detected that there is no GPS signal.

#define Msg_IDT_GPS_NOSIGNAL 0x0005L

Msg_IDT_GPS_SIGNALBACK

CoPilot detected that GPS signal is back.

#define Msg_IDT_GPS_SIGNALBACK 0x0006L

Msg_IDT_GPS_DETERMINING_POS

CoPilot is determining current position.

#define Msg_IDT_GPS_DETERMINING_POS 0x0007L

Msg_IDT_TRIP_NOSTOP

No stop in the CoPilot itinerary.

#define Msg_IDT_TRIP_NOSTOP 0x0008L

Msg_IDT_GPS_SEARCHING

CoPilot is searching for a GPS signal.

#define Msg_IDT_GPS_SEARCHING 0x0009L

Msg_IDT_WAYPOINT_PASSED

One of the waypoints in CoPilot itinerary has been passed.

#define Msg_IDT_WAYPOINT_PASSED 0x000AL

Msg_IDT_TRIP_CHANGED

CoPilot itinerary changed.

#define Msg_IDT_TRIP_CHANGED 0x000BL

Msg_IDT_ROUTE_RESTRICTEDDEST

Destination is on a restricted route.

#define Msg_IDT_ROUTE_RESTRICTEDDEST 0x000DL

Msg_IDT_ROUTE_RESTRICTEDROAD

Route contains restricted road.

#define Msg_IDT_ROUTE_RESTRICTEDROAD 0x000EL

Msg_IDT_ROUTE_CALCFAILED

Route calculation is failed.

#define Msg_IDT_ROUTE_CALCFAILED 0x000FL

Msg_IDT_RESTRICTED_ROAD

Restricted road.

#define Msg_IDT_RESTRICTED_ROAD 0x0010L

Msg_IDT_DISTUNIT_CHANGED

Distance Unit changed.

#define Msg_IDT_DISTUNIT_CHANGED 0x0011L

Msg_IDT_XMILES_NOTIFICATION

#define Msg_IDT_XMILES_NOTIFICATION 0x0012L

This notification is being sent when user is X miles/kms (based on the unit selected in CoPilot) away from the destination. The user can configure the X distance in 2 ways:

User.cfg (Static way to change the distance notification settings)

[SDK] “NotificationXDist” = 2

By using above settings, CoPilot will provide Msg_IDT_XMILES_NOTIFICATION, once user is 0.2 miles/kms away from the destination.

Using API (Dynamic way to change the distance notification settings)

The user can use Msg_ConfigSetIntVal to set the NotificationXDist settings in CoPilot.

E.g. Msg_ConfigSetIntVal (“SDK”," NotificationXDist “, 20)

By using the above settings, CoPilot will provide Msg_IDT_XMILES_NOTIFICATION, once user is 2 miles/kms away from destination.

Additional Notes

• Value of the NotificationXDist is always in multiplication of 10. If the user wants to have notification at 0.2 miles/kms from the destination, the user needs to pass 2.

• User can change the notification value at any time. E.g. initially the user sets the notification at 2 mile by using Msg_ConfigSetIntVal (passing 20). The user gets the notification when user is 2 miles away from destination. Now the user wants to have another notification at 0.3 miles. This notification can be set again by using the Msg_ConfigSetIntVal by passing 3.

• Once the value is set, it will be applied for all the destinations. If notification is not required then the user can unsubscribe the routing event or set the value as 0.

• The user can get the notification once for a given value.e.g.

  • If the user sets the notification at 0.3 miles and gets the notification at 0.3 mile.
  • If the user is off route before reaching the destination and travelling away from destination.
  • When user is back again within 0.3 mile to destination. CoPilot will not send notification as it is already being sent.

Msg_IDT_ROUTE_SYNC_MISMATCH

This notification is being sent if RouteSync provided route is not match with planned route by CoPilot.

#define Msg_IDT_ROUTE_SYNC_MISMATCH 0x0013L

Msg_IDT_ROUTE_SYNC_CALC_FINISHED

This notification is being sent on completion of route sync route calculation.

#define Msg_IDT_ROUTE_SYNC_CALC_FINISHED 0x0015L

Msg_IDT_TRAFFIC_DELAY

This notification is being sent if active traffic is enabled. lPayload contain delay in number of minutes in ETA.

This notification is used with traffic bar and active traffic settings on the CoPilot. This notification is being sent whenever traffic bar is being refresh.

#define Msg_IDT_TRAFFIC_DELAY 0x0014L

Example

Msg_Subscribe(MSG_ID_RoutingEvents):
Msg_UpdateOptions(MSG_ID_RoutingEvents, true, false, MyRoutingEventsCallback);

//Receiving side either by callback or through message queue mechanism
void MyRoutingEventCallback(const char *pBuf, const unsigned long lBufLen) {
  long lRoutingEvent, lPayload;
  Msg_GetRoutingEvent(pBuf, lBufLen, lRoutingEvent, lPayload);
}

Notes

• Above messages are divided into different categories to allow the client application to control what it wants to receive. By default the values in CoPilot user.cfg = 0, as per the example below, as a result the messages will be disabled. To enable the messages the config values should = 1.

Please note that configurations can be different in different version of CoPilot

• rPayload is used with Msg_IDT_ROUTECALC_PROGRESS and Msg_IDT_DISTUNIT_CHANGED
• rPayload when used with Msg_IDT_ROUTECALC_PROGRESS, it is used to show the percentage progress in route calculation.
• rPayload when used with Msg_IDT_DISTUNIT_CHANGED, indicates when the unit is changed to English (rPayload = 1) or Metric (rPayload = 0).
• rPayload in Msg_IDT_TRAFFIC_DELAY indicates the number of mins of delay due to traffic in current route.

Msg_GetTurnDistances

Provides turn distance information received through a subscription to Msg_ID_TurnDist. Turn information includes next and second turn distances.

Syntax (Prototyped in alkmsg.h)

long Msg_GetTurnDistances(const char *pBuf, const long lBufLen,
    double &dNextTurnDist,
    double &dSecondTurnDist,
    double &dDestDist, double &dAirDist,
    double &dETA);

Parameters

Return Value

• Less than or equal to 0 = Failed
• Greater than 0 = Successful

Msg_GetTurnInstructions

Returns turn instruction information received through a subscription to Msg_ID_TurnInstructions. Information includes turn image, street information. We recommend using Msg_GetTurnInstructionsEx instead of Msg_GetTurnInstructions.

Syntax (Prototyped in alkmsg.h)

long Msg_GetTurnInstructions(const char *pBuf,
   const long lBufLen,
   char *pszNextTurn,
   long lNextTurnLen,
   char *pszSecondTurn,
   long lSecondTurnLen,
   char *pszCurrentStreet,
   long lCurrentStreetLen,
   char *pszTurnStreet,
   long lTurnStreetLen,
   char *pszTurnAction,
   long lTurnActionLen,
   shor &lTurnImage);

Parameters

Table: Turn image codes retrieved using Msg_GetTurnInstructions()

Turn Image Code (Right Drive)	Turn Image Code (Left Drive)	Description	Image
-1	-1	No Next Turn
0	32	Straight
1	33	Left (90 degrees)
2	34	Right (90 degrees)
3	35	Bear Left
4	36	Bear Right
5	37	Sharp Left
6	38	Sharp Right
7	39	Left U-turn
8	40	Blank
9	9	No GPS signal (image of satellite)
10	10	Final Destination (checkered flag)
16	48	Straight through traffic circle
17	49	Left through traffic circle (270degrees CCW)
18	50	Right through traffic circle (90 degrees CCW)
19	51	Bear Left through traffic circle
20	52	Bear Right through traffic circle
21	53	Sharp Left through traffic circle
22	54	Sharp Right through traffic circle
23	55	U-Turn through traffic circle (180 degrees CCW)
67	99	Merge Right
68	100	Merge Left
>128	>128	Exit from the highway/Motorway

Note: For determining whether the Exit code is related to left hand drive or right hand drive, please subtract 128 from the returned code. This result should match one of the unique numbers on Left Drive or Right Drive. For Example- Returned Turn Image Code is 130. Subtracting 128 from it will return 2. Now two matches Right Exit (in Right Hand Drive). So it is right hand drive.

Return Value

Always returns 1

Msg_GetTurnInstructionsEx

Returns turn instruction information received through a subscription to Msg_ID_TurnInstructions. Information includes: turn image, street information and street class information. We recommend using Msg_GetTurnInstructionsEx instead of Msg_GetTurnInstructions.

Syntax (Prototyped in alkmsg.h)

long Msg_GetTurnInstructionsEx(const char *pBuf,
                               const long lBufLen,
                               char *pszNextTurn,
                               long lNextTurnLen,
                               char *pszSecondTurn,
                               long lSecondTurnLen,
                               char *pszCurrentStreet,
                               long lCurrentStreetLen,
                               char *pszTurnStreet,
                               long lTurnStreetLen,
                               char *pszTurnAction,
                               long lTurnActionLen,
                               short &lTurnImage,
                               short &lCurrentStreetClass,
                               short &lCurrentStreetRoadSpeed,
                               short &lSecondTurnImage,
                               short &lIsTruckSpeedLimit);

Parameters

Table: Turn image codes retrieved using Msg_GetTurnInstructions()

Turn Image Code (Right Drive)	Turn Image Code (Left Drive)	Description	Image
-1	-1	No Next Turn
0	32	Straight
1	33	Left (90 degrees)
2	34	Right (90 degrees)
3	35	Bear Left
4	36	Bear Right
5	37	Sharp Left
6	38	Sharp Right
7	39	Left U-turn
8	40	Blank
9	9	No GPS signal (image of satellite)
10	10	Final Destination (checkered flag)
16	48	Straight through traffic circle
17	49	Left through traffic circle (270degrees CCW)
18	50	Right through traffic circle (90 degrees CCW)
19	51	Bear Left through traffic circle
20	52	Bear Right through traffic circle
21	53	Sharp Left through traffic circle
22	54	Sharp Right through traffic circle
23	55	U-Turn through traffic circle (180 degrees CCW)
67	99	Merge Right
68	100	Merge Left
>128	>128	Exit from the highway/Motorway

enum TRoadClass

{
   RC_CLOSED = 0,
   RC_INTERSTATE = 1,     //Inter state
   RC_INTERSTATE_NORAMPS, //Inter state with No Ramp
   RC_DIVIDED,            //Divided road
   RC_PRIMARY,            //Primary Road
   RC_FERRY,              //Ferry
   RC_SECONDARY,          //Secondary Road
   RC_RAMP,               //Ramp
   RC_LOCAL,              //Local Street
   RC_MAX
};

Note: For determining whether the Exit code is related to left hand drive or right hand drive, please subtract 128 from the returned code. This result should match one of the unique numbers on Left Drive or Right Drive. For Example- Returned Turn Image Code is 130. Subtracting 128 from it will return 2. Now two matches Right Exit (in Right Hand Drive). So it is right hand drive.

Return Value

Always returns 1

Msg_GetCountryBorderInfo

Decode and retrieve the country border crossing information contained in a message buffer received through a subscription to Msg_ID_CountryBorderEvent. For North America region the information relates to crossing a state.

Syntax (Prototyped in alkmsg.h)

long Msg_GetCountryBorderInfo(void *pBuffer,
                              unsigned long lBufLen,
                              char *pCountryName,
                              unsigned long lCountryNameLen,
                              char* pLanguage,
                              unsigned long lLanguageLen,
                              char *pDriveSide,
                              unsigned long lDriveSideLen,
                              char *pUnit,
                              unsigned long lUnitLen,
                              char *pCurrency,
                              unsigned long lCurrencyLen);

Parameters

Return Value

• Less than or equal to 0 = Failed
• Greater than 0 = Successful

Msg_GetSpeedLimitEvent

Extracts and parses the over-speedlimit or current-speedlimit information buffer from a message buffer. Dependency - Msg_Subscribe(Msg_ID_OverSpeedLimitEvent) OR Msg_Subscribe(Msg_ID_OverSpeedLimitEvent). We recommend using Msg_GetSpeedLimitEventEx instead of Msg_GetSpeedLimitEvent

Syntax (Prototyped in alkmsg.h)

long Msg_GetSpeedLimitEvent(void *pBuffer,
   unsigned long lBufLen,
   unsigned long &lEventType,
   long &lPayload)

Parameters

Return Value

• Less than or equal to 0 = Failed
• Greater than 0 = Successful

Msg_GetSpeedLimitEventEx

Extracts and parses the over-speedlimit or current-speedlimit information buffer from a message buffer. Dependency - Msg_Subscribe(Msg_ID_OverSpeedLimitEvent) OR Msg_Subscribe(Msg_ID_OverSpeedLimitEvent)

Syntax (Prototyped in alkmsg.h)

long Msg_GetSpeedLimitEventEx(void *pBuffer,
   unsigned long lBufLen,
   unsigned long &lEventType,
   long &lPayload,
   long &lTruck,
   long &lActual)

Parameters

Return Value

• Less than or equal to 0 = Failed
• Greater than 0 - Successful

Msg_ID_OverSpeedLimitEvent/Msg_ID_CurrentSpeedLimitEvent

• Raises an event with message identifier - Msg_ID_CurrentSpeedLimitEvent or Msg_ID_CurrentSpeedLimitEvent.
• Use Msg_GetSpeedLimitEvent (or Msg_GetSpeedLimitEventEx which is recommended) to decode the data received.
• For setting the parameter for a Speed Limit warning, use Msg_CreateGenericInformation, Msg_GenericInformationAddDetail, Msg_SendGenericInformation.

Msg_SendTripDetour

Sends a simple request to CoPilot to detour from the current route, no user interaction required.

Syntax (Prototyped in alkmsg.h)

long Msg_SendTripDetour(long lDestID = CONN_ID_NONE,
   long lSrcID = CONN_ID_NONE);

Parameters

Return Value

• Less than or equal to 0 = Failed
• Greater than 0 = Successful