le_ecall_interface.h File Reference
Go to the source code of this file.
Macros | |
#define | LE_ECALL_MSD_MAX_LEN 140 |
#define | LE_ECALL_VIN_MAX_LEN 17 |
#define | LE_ECALL_VIN_MAX_BYTES 18 |
Typedefs | |
typedef struct le_ecall_Call * | le_ecall_CallRef_t |
typedef struct le_ecall_StateChangeHandler * | le_ecall_StateChangeHandlerRef_t |
typedef void(* | le_ecall_StateChangeHandlerFunc_t) (le_ecall_CallRef_t ecallRef, le_ecall_State_t state, void *contextPtr) |
Detailed Description
Legato eCall include file.
Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
Macro Definition Documentation
#define LE_ECALL_MSD_MAX_LEN 140 |
MSD message length in bytes.
#define LE_ECALL_VIN_MAX_BYTES 18 |
Vehicle Identification Number (VIN) string BYTES. One extra byte is added for the null character.
#define LE_ECALL_VIN_MAX_LEN 17 |
Vehicle Identification Number (VIN) string LENGTH. (without nulltermination)
Typedef Documentation
typedef struct le_ecall_Call* le_ecall_CallRef_t |
Reference returned by Create function and used by other functions
typedef void(* le_ecall_StateChangeHandlerFunc_t) (le_ecall_CallRef_t ecallRef, le_ecall_State_t state, void *contextPtr) |
Handler for eCall state changes.
- Parameters
-
ecallRef eCall reference state eCall state contextPtr
typedef struct le_ecall_StateChangeHandler* le_ecall_StateChangeHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'le_ecall_StateChange'
Enumeration Type Documentation
Crash information Bit Mask (16 bits) indicating the type of road accident.
Diagnostic result Bit Mask (64 bits)
enum le_ecall_MsdTxMode_t |
eCall MSD vehicle type
enum le_ecall_OpMode_t |
Configured operation modes.
Enumerator | |
---|---|
LE_ECALL_NORMAL_MODE |
Normal mode. |
LE_ECALL_ONLY_MODE |
eCall only mode according to U/SIM operation mode or forced by application through the le_ecall_ForceOnlyMode() function. |
LE_ECALL_FORCED_PERSISTENT_ONLY_MODE |
Persistent eCall only mode. |
Propulsion type Bit Mask
enum le_ecall_State_t |
eCall session states.
Enumerator | |
---|---|
LE_ECALL_STATE_UNKNOWN |
Unknown state. |
LE_ECALL_STATE_STARTED |
eCall session started. |
LE_ECALL_STATE_CONNECTED |
Emergency call is established. |
LE_ECALL_STATE_DISCONNECTED |
Emergency call is disconnected. |
LE_ECALL_STATE_WAITING_PSAP_START_IND |
Waiting for PSAP start indication. |
LE_ECALL_STATE_PSAP_START_IND_RECEIVED |
PSAP start indication received. |
LE_ECALL_STATE_MSD_TX_STARTED |
MSD transmission is started. |
LE_ECALL_STATE_LLNACK_RECEIVED |
LL-NACK received. |
LE_ECALL_STATE_LLACK_RECEIVED |
LL-ACK received. |
LE_ECALL_STATE_MSD_TX_COMPLETED |
MSD transmission is complete. |
LE_ECALL_STATE_MSD_TX_FAILED |
MSD transmission has failed. |
LE_ECALL_STATE_ALACK_RECEIVED_POSITIVE |
AL-ACK received. |
LE_ECALL_STATE_ALACK_RECEIVED_CLEAR_DOWN |
AL-ACK clear-down received. |
LE_ECALL_STATE_STOPPED |
eCall session has been stopped by PSAP or IVS le_ecall_End(). |
LE_ECALL_STATE_RESET |
eCall session has lost synchronization and starts over. |
LE_ECALL_STATE_COMPLETED |
eCall session completed. The modem successfully completed the MSD transmission and received two AL-ACKs (positive). Can now switch to voice path. |
LE_ECALL_STATE_FAILED |
Unsuccessful eCall session. |
LE_ECALL_STATE_END_OF_REDIAL_PERIOD |
End of the redial period. |
LE_ECALL_STATE_TIMEOUT_T2 |
Timeout for Timer T2 (see CEN-EN 16062, annex A) |
LE_ECALL_STATE_TIMEOUT_T3 |
Timeout for Timer T3 (see CEN-EN 16062, annex A) |
LE_ECALL_STATE_TIMEOUT_T5 |
Timeout for Timer T5 (see CEN-EN 16062, annex A) |
LE_ECALL_STATE_TIMEOUT_T6 |
Timeout for Timer T6 (see CEN-EN 16062, annex A) |
LE_ECALL_STATE_TIMEOUT_T7 |
Timeout for Timer T7 (see CEN-EN 16062, annex A) |
LE_ECALL_STATE_TIMEOUT_T9 |
Timeout for Timer T9 (see CEN-EN 16062, annex A) |
LE_ECALL_STATE_TIMEOUT_T10 |
Timeout for Timer T10 (see CEN-EN 16062, annex A) |
Function Documentation
le_ecall_StateChangeHandlerRef_t le_ecall_AddStateChangeHandler | ( | le_ecall_StateChangeHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'le_ecall_StateChange'
This event provides information on eCall state changes.
- Parameters
-
[in] handlerPtr [in] contextPtr
void le_ecall_ConnectService | ( | void | ) |
Connect the current client thread to the service providing this API. Block until the service is available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.
This function is created automatically.
le_ecall_CallRef_t le_ecall_Create | ( | void | ) |
Create a new eCall object
The eCall is not actually established at this point. It's still up to the caller to call le_ecall_Start() when ready.
- Returns
- A reference to the new Call object.
- Note
- On failure, the process exits; you don't have to worry about checking the returned reference for validity.
void le_ecall_Delete | ( | le_ecall_CallRef_t | ecallRef | ) |
Call to free up a call reference.
- Note
- This will free the reference, but not necessarily stop an active eCall. If there are other holders of this reference the eCall will remain active.
- Parameters
-
[in] ecallRef eCall reference
void le_ecall_DisconnectService | ( | void | ) |
Disconnect the current client thread from the service providing this API.
Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.
This function is created automatically.
le_result_t le_ecall_End | ( | le_ecall_CallRef_t | ecallRef | ) |
End the current eCall session
- Returns
- LE_OK on success
- LE_BAD_PARAMETER bad eCall reference
- LE_FAULT for other failures
- Parameters
-
[in] ecallRef eCall reference
le_result_t le_ecall_ExitOnlyMode | ( | void | ) |
This function exits from eCall Only mode. It configures the eCall operation mode to Normal mode, the modem uses the default operation mode at power up (or after U/SIM hotswap). The modem behaves following the U/SIM eCall operation mode; for example the U/SIM can be configured only for eCall, or a combination of eCall and commercial service provision.
- Returns
- LE_OK on success
- LE_FAULT for other failures
le_result_t le_ecall_ExportMsd | ( | le_ecall_CallRef_t | ecallRef, |
uint8_t * | msdPtr, | ||
size_t * | msdNumElementsPtr | ||
) |
Export the encoded MSD.
- Returns
- LE_OK on success
- LE_OVERFLOW The encoded MSD length exceeds the user's buffer length.
- LE_NOT_FOUND No encoded MSD is available.
- LE_BAD_PARAMETER bad eCall reference.
- LE_FAULT for other failures.
- Note
- If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
- Parameters
-
[in] ecallRef eCall reference [out] msdPtr the encoded MSD [in,out] msdNumElementsPtr
le_result_t le_ecall_ForceOnlyMode | ( | void | ) |
This function configures the eCall operation mode to eCall only, only emergency number can be used to start an eCall session. The modem doesn't try to register on the Cellular network. This function forces the modem to behave as eCall only mode whatever U/SIM operation mode. The change doesn't persist over power cycles. This function can be called before making an eCall.
- Returns
- LE_OK on success
- LE_FAULT for other failures
le_result_t le_ecall_ForcePersistentOnlyMode | ( | void | ) |
Same as le_ecall_ForceOnlyMode(), but the change persists over power cycles.
- Returns
- LE_OK on success
- LE_FAULT for other failures
le_result_t le_ecall_GetConfiguredOperationMode | ( | le_ecall_OpMode_t * | opModePtr | ) |
Get the configured Operation mode.
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Parameters
-
[out] opModePtr Operation mode
le_result_t le_ecall_GetEraGlonassAutoDialAttempts | ( | uint16_t * | attemptsPtr | ) |
Get the AUTO_DIAL_ATTEMPTS value.
- Returns
- LE_OK on success
- LE_FAULT on failure
- Parameters
-
[out] attemptsPtr the AUTO_DIAL_ATTEMPTS value
le_result_t le_ecall_GetEraGlonassDialDuration | ( | uint16_t * | durationPtr | ) |
Get the ECALL_DIAL_DURATION time.
- Returns
- LE_OK on success
- LE_FAULT on failure
- Parameters
-
[out] durationPtr the ECALL_DIAL_DURATION time value (in seconds)
le_result_t le_ecall_GetEraGlonassManualDialAttempts | ( | uint16_t * | attemptsPtr | ) |
Get the MANUAL_DIAL_ATTEMPTS value.
- Returns
- LE_OK on success
- LE_FAULT on failure
- Parameters
-
[out] attemptsPtr the MANUAL_DIAL_ATTEMPTS value
le_result_t le_ecall_GetIntervalBetweenDialAttempts | ( | uint16_t * | pausePtr | ) |
Get the minimum interval value between dial attempts.
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Parameters
-
[out] pausePtr the minimum interval value in seconds
le_result_t le_ecall_GetMsdTxMode | ( | le_ecall_MsdTxMode_t * | modePtr | ) |
Get the push/pull transmission mode.
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Parameters
-
[out] modePtr Transmission mode
le_result_t le_ecall_GetMsdVersion | ( | uint32_t * | msdVersionPtr | ) |
Get the MSD version.
- Returns
- LE_OK on success
- LE_FAULT for other failures
- LE_BAD_PARAMETER parameter is NULL
- Parameters
-
[out] msdVersionPtr Msd version
le_result_t le_ecall_GetNadDeregistrationTime | ( | uint16_t * | deregTimePtr | ) |
Get the NAD_DEREGISTRATION_TIME value.
- Returns
- LE_OK on success
- LE_FAULT on failure
- Parameters
-
[out] deregTimePtr the NAD_DEREGISTRATION_TIME value (in minutes).
int32_t le_ecall_GetPlatformSpecificTerminationCode | ( | le_ecall_CallRef_t | ecallRef | ) |
Called to get the platform specific termination code.
- Returns
- The platform specific termination code.
- Note
- If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
- Parameters
-
[in] ecallRef eCall reference.
le_result_t le_ecall_GetPropulsionType | ( | le_ecall_PropulsionTypeBitMask_t * | propulsionTypePtr | ) |
Get the propulsion stored. Note that a vehicle may have more than one propulsion type.
- Returns
- LE_OK on success
- LE_NOT_FOUND if the value is not set.
- LE_FAULT for other failures
- LE_BAD_PARAMETER parameter is NULL
- Parameters
-
[out] propulsionTypePtr bitmask
le_result_t le_ecall_GetPsapNumber | ( | char * | psap, |
size_t | psapNumElements | ||
) |
Get the Public Safely Answering Point telephone number set with le_ecall_SetPsapNumber() function.
- Note
- That PSAP number is not applied to Manually or Automatically initiated eCall. For those modes, an emergency call is launched.
- Warning
- This function doesn't read the U/SIM content.
- Returns
- LE_OK on success
- LE_FAULT on failures or if le_ecall_SetPsapNumber() has never been called before.
- Parameters
-
[out] psap Public Safely Answering Point telephone number [in] psapNumElements
le_ecall_State_t le_ecall_GetState | ( | le_ecall_CallRef_t | ecallRef | ) |
Get the current state for the given eCall
- Returns
- The current state for the given eCall
- Note
- The process exits, if an invalid eCall reference is given
- Parameters
-
[in] ecallRef eCall reference
le_result_t le_ecall_GetSystemStandard | ( | le_ecall_SystemStandard_t * | systemStandardPtr | ) |
Get the system standard.
- Returns
- LE_OK on success
- LE_FAULT for other failures
- LE_BAD_PARAMETER parameter is NULL
- Parameters
-
[out] systemStandardPtr System Standard
le_mcc_TerminationReason_t le_ecall_GetTerminationReason | ( | le_ecall_CallRef_t | ecallRef | ) |
Called to get the termination reason.
- Returns
- The termination reason.
- Note
- If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
- Parameters
-
[in] ecallRef eCall reference.
le_result_t le_ecall_GetVehicleType | ( | le_ecall_MsdVehicleType_t * | vehicleTypePtr | ) |
Get the Vehicled Type.
- Returns
- LE_OK on success
- LE_BAD_PARAMETER parameter is NULL
- LE_FAULT for other failures
- Parameters
-
[out] vehicleTypePtr Vehicle type
le_result_t le_ecall_GetVIN | ( | char * | vin, |
size_t | vinNumElements | ||
) |
Get the VIN (Vehicle Identification Number).
- Returns
- LE_OK on success
- LE_NOT_FOUND if the value is not set.
- LE_BAD_PARAMETER parameter is NULL or to small
- Parameters
-
[out] vin VIN is gotten with a null termination. [in] vinNumElements
le_result_t le_ecall_ImportMsd | ( | le_ecall_CallRef_t | ecallRef, |
const uint8_t * | msdPtr, | ||
size_t | msdNumElements | ||
) |
Import an already prepared MSD.
MSD is transmitted only after an emergency call has been established.
- Returns
- LE_OK on success
- LE_OVERFLOW The imported MSD length exceeds the MSD_MAX_LEN maximum length.
- LE_BAD_PARAMETER bad eCall reference
- LE_FAULT for other failures
- Note
- On failure, the process exits; you don't have to worry about checking the returned reference for validity.
- Parameters
-
[in] ecallRef eCall reference [in] msdPtr the prepared MSD [in] msdNumElements
void le_ecall_RemoveStateChangeHandler | ( | le_ecall_StateChangeHandlerRef_t | addHandlerRef | ) |
Remove handler function for EVENT 'le_ecall_StateChange'
- Parameters
-
[in] addHandlerRef
le_result_t le_ecall_ResetMsdEraGlonassCrashInfo | ( | le_ecall_CallRef_t | ecallRef | ) |
Reset the ERA-GLONASS crash type bit mask. Optional parameter is not included in the MSD message.
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad eCall reference
- Parameters
-
[in] ecallRef eCall reference
le_result_t le_ecall_ResetMsdEraGlonassCrashSeverity | ( | le_ecall_CallRef_t | ecallRef | ) |
Reset the ERA-GLONASS crash severity parameter. Therefore that optional parameter is not included in the MSD message.
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad eCall reference
- Parameters
-
[in] ecallRef eCall reference
le_result_t le_ecall_ResetMsdEraGlonassDiagnosticResult | ( | le_ecall_CallRef_t | ecallRef | ) |
Reset the ERA-GLONASS diagnostic result bit mask. Optional parameter is not included in the MSD message.
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad eCall reference
- Parameters
-
[in] ecallRef eCall reference
le_result_t le_ecall_SendMsd | ( | le_ecall_CallRef_t | ecallRef | ) |
Send the MSD.
- Returns
- LE_OK on success
- LE_BAD_PARAMETER bad eCall reference
- LE_FAULT for other failures
- Note
- On failure, the process exits, so you don't have to worry about checking the returned reference for validity.
- Parameters
-
[in] ecallRef eCall reference
le_result_t le_ecall_SetEraGlonassAutoDialAttempts | ( | uint16_t | attempts | ) |
Set tthe AUTO_DIAL_ATTEMPTS value. If a dial attempt under automatic emergency call initiation failed, it should be repeated maximally ECALL_AUTO_DIAL_ATTEMPTS-1 times within the maximal time limit of ECALL_DIAL_DURATION. The default value is 10. Redial attempts stop once the call has been cleared down correctly, or if counter/timer reached their limits.
- Returns
- LE_OK on success
- LE_FAULT on failure
- Parameters
-
[in] attempts the AUTO_DIAL_ATTEMPTS value
le_result_t le_ecall_SetEraGlonassDialDuration | ( | uint16_t | duration | ) |
Set the ECALL_DIAL_DURATION time. It's the maximum time the IVS have to connect the emergency call to the PSAP, including all redial attempts. If the call is not connected within this time (or ManualDialAttempts/AutoDialAttempts dial attempts), it will stop.
- Returns
- LE_OK on success
- LE_FAULT on failure
- Parameters
-
[in] duration the ECALL_DIAL_DURATION time value (in seconds)
le_result_t le_ecall_SetEraGlonassManualDialAttempts | ( | uint16_t | attempts | ) |
Set the MANUAL_DIAL_ATTEMPTS value. If a dial attempt under manual emergency call initiation failed, it should be repeated maximally ECALL_MANUAL_DIAL_ATTEMPTS-1 times within the maximal time limit of ECALL_DIAL_DURATION. The default value is 10. Redial attempts stop once the call has been cleared down correctly, or if counter/timer reached their limits.
- Returns
- LE_OK on success
- LE_FAULT on failure
- Parameters
-
[in] attempts the MANUAL_DIAL_ATTEMPTS value
le_result_t le_ecall_SetIntervalBetweenDialAttempts | ( | uint16_t | pause | ) |
Set the minimum interval value between dial attempts.
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Parameters
-
[in] pause the minimum interval value in seconds
le_result_t le_ecall_SetMsdEraGlonassCrashInfo | ( | le_ecall_CallRef_t | ecallRef, |
le_ecall_CrashInfoBitMask_t | crashInfoMask | ||
) |
Set the ERA-GLONASS crash type bit mask
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad eCall reference
- Parameters
-
[in] ecallRef eCall reference [in] crashInfoMask ERA-GLONASS crash type bit mask.
le_result_t le_ecall_SetMsdEraGlonassCrashSeverity | ( | le_ecall_CallRef_t | ecallRef, |
uint32_t | crashSeverity | ||
) |
Set the ERA-GLONASS crash severity parameter.
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad eCall reference
- Parameters
-
[in] ecallRef eCall reference [in] crashSeverity the ERA-GLONASS crash severity parameter
le_result_t le_ecall_SetMsdEraGlonassDiagnosticResult | ( | le_ecall_CallRef_t | ecallRef, |
le_ecall_DiagnosticResultBitMask_t | diagnosticResultMask | ||
) |
Set the ERA-GLONASS diagnostic result using a bit mask.
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad eCall reference
- Parameters
-
[in] ecallRef eCall reference [in] diagnosticResultMask ERA-GLONASS diagnostic result bit mask.
le_result_t le_ecall_SetMsdPassengersCount | ( | le_ecall_CallRef_t | ecallRef, |
uint32_t | paxCount | ||
) |
Set the number of passengers transmitted by the MSD.
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad eCall reference
- Note
- The process exits, if an invalid eCall reference is given
- Parameters
-
[in] ecallRef eCall reference [in] paxCount number of passengers
le_result_t le_ecall_SetMsdPosition | ( | le_ecall_CallRef_t | ecallRef, |
bool | isTrusted, | ||
int32_t | latitude, | ||
int32_t | longitude, | ||
int32_t | direction | ||
) |
Set the position transmitted by the MSD.
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad input parameter
- LE_FAULT on other failures
- Note
- The process exits, if an invalid eCall reference is given
- Parameters
-
[in] ecallRef eCall reference [in] isTrusted true if the position is accurate, false otherwise [in] latitude latitude in degrees with 6 decimal places, positive North. Maximum value is +90 degrees (+90000000), minimum value is -90 degrees (-90000000). [in] longitude longitude in degrees with 6 decimal places, positive East. Maximum value is +180 degrees (+180000000), minimum value is -180 degrees (-180000000). [in] direction direction of the vehicle from magnetic north (0 to 358, clockwise) in 2-degrees unit. Valid range is 0 to 179. If direction of travel is invalid or unknown, the value 0xFF shall be used.
le_result_t le_ecall_SetMsdPositionN1 | ( | le_ecall_CallRef_t | ecallRef, |
int32_t | latitudeDeltaN1, | ||
int32_t | longitudeDeltaN1 | ||
) |
Set the position Delta N-1 from position set in le_ecall_SetMsdPosition() transmitted by the MSD.
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad input parameter
- LE_FAULT on other failures
- Note
- The process exits, if an invalid eCall reference is given
- Parameters
-
[in] ecallRef eCall reference [in] latitudeDeltaN1 longitude delta from position set in SetMsdPosition 1 Unit = 100 miliarcseconds, which is approximately 3m maximum value: 511 = 0 0'51.100'' (+- 1580m) minimum value: -512 = -0 0'51.200'' (+- -1583m) [in] longitudeDeltaN1 longitude delta from position set in SetMsdPosition 1 Unit = 100 miliarcseconds, which is approximately 3m maximum value: 511 = 0 0'51.100'' (+-1580m) minimum value: -512 = -0 0'51.200'' (+- -1583m) )
le_result_t le_ecall_SetMsdPositionN2 | ( | le_ecall_CallRef_t | ecallRef, |
int32_t | latitudeDeltaN2, | ||
int32_t | longitudeDeltaN2 | ||
) |
Set the position Delta N-2 from position set in le_ecall_SetMsdPositionN1() transmitted by the MSD.
- Returns
- LE_OK on success
- LE_DUPLICATE an MSD has been already imported
- LE_BAD_PARAMETER bad input parameter
- LE_FAULT on other failures
- Note
- The process exits, if an invalid eCall reference is given
- Parameters
-
[in] ecallRef eCall reference [in] latitudeDeltaN2 longitude delta from position set in SetMsdPositionN1 1 Unit = 100 miliarcseconds, which is approximately 3m maximum value: 511 = 0 0'51.100'' (+-1580m) minimum value: -512 = -0 0'51.200'' (+- -1583m) [in] longitudeDeltaN2 longitude delta from position set in SetMsdPositionN1 1 Unit = 100 miliarcseconds, which is approximately 3m maximum value: 511 = 0 0'51.100'' (+-1580m) minimum value: -512 = -0 0'51.200'' (+- -1583m) )
le_result_t le_ecall_SetMsdTxMode | ( | le_ecall_MsdTxMode_t | mode | ) |
Set the push/pull transmission mode.
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Parameters
-
[in] mode Transmission mode
le_result_t le_ecall_SetMsdVersion | ( | uint32_t | msdVersion | ) |
Set the MSDs version. Default value is 1
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Parameters
-
[in] msdVersion Msd version
le_result_t le_ecall_SetNadDeregistrationTime | ( | uint16_t | deregTime | ) |
Set the NAD_DEREGISTRATION_TIME value. After termination of an emergency call the in-vehicle system remains registered on the network for the period of time, defined by the installation parameter NAD_DEREGISTRATION_TIME.
- Returns
- LE_OK on success
- LE_FAULT on failure
- Parameters
-
[in] deregTime the NAD_DEREGISTRATION_TIME value (in minutes).
le_result_t le_ecall_SetPropulsionType | ( | le_ecall_PropulsionTypeBitMask_t | propulsionType | ) |
Set the propulsion type. Note that a vehicle may have more than one propulsion type.
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Parameters
-
[in] propulsionType bitmask
le_result_t le_ecall_SetPsapNumber | ( | const char * | psap | ) |
Set the Public Safely Answering Point telephone number.
- Note
- That PSAP number is not applied to Manually or Automatically initiated eCall. For those modes, an emergency call is launched.
- Warning
- This function doesn't modified the U/SIM content.
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Note
- If PSAP number is too long (max LE_MDMDEFS_PHONE_NUM_MAX_LEN digits), it is a fatal error, the function will not return.
- Parameters
-
[in] psap Public Safely Answering Point number
le_result_t le_ecall_SetSystemStandard | ( | le_ecall_SystemStandard_t | systemStandard | ) |
Set the system standard. Default is PAN EUROPEAN
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Parameters
-
[in] systemStandard System standard
le_result_t le_ecall_SetVehicleType | ( | le_ecall_MsdVehicleType_t | vehicleType | ) |
Set the Vehicled Type Default value is 0
- Returns
- LE_OK on success
- LE_FAULT for other failures
- Parameters
-
[in] vehicleType Vehicle type
le_result_t le_ecall_SetVIN | ( | const char * | vin | ) |
Set the VIN (Vehicle Identification Number).
- Returns
- LE_OK on success
- LE_BAD_PARAMETER parameter is NULL.
- LE_FAULT for other failures
- Parameters
-
[in] vin VIN (Vehicle Identification Number)
le_result_t le_ecall_StartAutomatic | ( | le_ecall_CallRef_t | ecallRef | ) |
Start an automatic eCall session
- Returns
- LE_OK on success
- LE_BUSY an eCall session is already in progress
- LE_BAD_PARAMETER bad eCall reference
- LE_FAULT for other failures
- Note
- The process exits, if an invalid eCall reference is given
- Parameters
-
[in] ecallRef eCall reference
le_result_t le_ecall_StartManual | ( | le_ecall_CallRef_t | ecallRef | ) |
Start a manual eCall session
- Returns
- LE_OK on success
- LE_BUSY an eCall session is already in progress
- LE_BAD_PARAMETER bad eCall reference
- LE_FAULT for other failures
- Note
- The process exits, if an invalid eCall reference is given
- Parameters
-
[in] ecallRef eCall reference
le_result_t le_ecall_StartTest | ( | le_ecall_CallRef_t | ecallRef | ) |
Start a test eCall session
- Returns
- LE_OK on success
- LE_BUSY an eCall session is already in progress
- LE_BAD_PARAMETER bad eCall reference
- LE_FAULT for other failures
- Note
- The process exits, if an invalid eCall reference is given
- Parameters
-
[in] ecallRef eCall reference
le_result_t le_ecall_TryConnectService | ( | void | ) |
Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.
For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.
This function is created automatically.
- Returns
- LE_OK if the client connected successfully to the service.
- LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
- LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
- LE_COMM_ERROR if the Service Directory cannot be reached.
le_result_t le_ecall_UseUSimNumbers | ( | void | ) |
This function can be recalled to indicate the modem to read the number to dial from the FDN/SDN of the U/SIM, depending upon the eCall operating mode.
- Returns
- LE_OK on success
- LE_FAULT for other failures