le_ecall_interface.h

Go to the documentation of this file.
1 
2 
3 /*
4  * ====================== WARNING ======================
5  *
6  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
7  * DO NOT MODIFY IN ANY WAY.
8  *
9  * ====================== WARNING ======================
10  */
11 
12 /**
13  * @page c_ecall eCall
14  *
15  * @ref le_ecall_interface.h "API Reference" <br>
16  * @ref howToEcall <br>
17  * @ref sampleApps_eCall sample app <br>
18  * @ref le_ecall_samples <br>
19  *
20  * <HR>
21  *
22  * eCall is a technology initiative intended to bring rapid assistance to auto
23  * accidents anywhere in the European Union. When a serious vehicle accident occurs,
24  * sensors automatically trigger an eCall. When activated, the in-vehicle system (IVS)
25  * establishes a 112-voice connection.
26  *
27  * The Mobile Network Operator handles the eCall like any other 112 call and routes the call to the
28  * most appropriate emergency response centre - Public Safety Answering Point (PSAP).
29  *
30  * At the same time, a digital "minimum set of data" (MSD) message is sent over the voice call using
31  * in-band modem signals. The MSD includes accident information like time, location, driving
32  * direction, and vehicle description.
33  *
34  * The eCall can also be activated manually. The mobile network operator identifies that the 112
35  * call is an eCall from the “eCall flag” inserted by the vehicle’s communication module.
36  *
37  * This API applies for both PAN-EUROPEAN and ERA-GLONASS standards.
38  *
39  * @note eCall service is only available on automotive products.
40  *
41  * @section le_ecall_binding IPC interfaces binding
42  *
43  * All the functions of this API are provided by the @b modemService service.
44  *
45  * Here's a code sample binding to modem services:
46  * @verbatim
47  bindings:
48  {
49  clientExe.clientComponent.le_ecall -> modemService.le_ecall
50  }
51  @endverbatim
52  *
53  * @section le_ecall_operation Operation modes
54  *
55  * The modem can be configured to operate in three different operation modes:
56  * - le_ecall_ForceOnlyMode(): this function configures the eCall operation mode to eCall only, only
57  * emergency number can be used to start an eCall session. The modem doesn't try to register on
58  * the Cellular network. This function forces the modem to behave as eCall only mode whatever
59  * U/SIM operation mode. The change doesn't persist over power cycles.
60  * This function can be called before making an eCall.
61  *
62  * - le_ecall_ForcePersistentOnlyMode(): Same as le_ecall_ForceOnlyMode(), but the change persists
63  * over power cycles.
64  *
65  * - le_ecall_ExitOnlyMode(): this function exits from eCall Only mode. It configures the eCall
66  * operation mode to Normal mode, the modem uses the default operation mode at power up (or after
67  * U/SIM hotswap). The modem behaves following the U/SIM eCall operation mode; for example the
68  * U/SIM can be configured only for eCall, or a combination of eCall and commercial service
69  * provision.
70  *
71  * - le_ecall_GetConfiguredOperationMode(): this function allows the user to retrieve the configured
72  * Operation mode.
73  * The configured operation mode can be:
74  * - @c LE_ECALL_NORMAL_MODE : normal mode. The modem behaves following the U/SIM eCall operation
75  * mode.
76  * - @c LE_ECALL_ONLY_MODE : eCall only mode according to U/SIM operation mode or forced by
77  * application through the le_ecall_ForceOnlyMode() function.
78  * - @c LE_ECALL_FORCED_PERSISTENT_ONLY_MODE : persistent eCall only mode.
79  *
80  * @section le_ecall_session eCall Session
81  *
82  * An eCall session is started by creating an eCall object with the le_ecall_Create() function.
83  * The eCall session can then be stopped with le_ecall_End().
84  *
85  * The eCall type and the kind of activation are specified using different functions to start the
86  * eCall session:
87  * - le_ecall_StartManual(): initiate a manual eCall session (triggered by a passenger)
88  * - le_ecall_StartAutomatic(): initiate an automatic eCall session (automatically triggered by
89  * the IVS in case of accident)
90  * - le_ecall_StartTest(): initiate a test eCall session (to test the communication between the
91  * IVS and the PSAP)
92  *
93  * @warning An application must wait for the end of the ongoing eCall before triggering another
94  * one with the @c le_ecall_StartXxx() functions. An eCall is ended when:
95  * - the application successfully ended it with le_ecall_End() returning @c LE_OK
96  * - or the event @ref LE_ECALL_STATE_STOPPED is received
97  * - or the event @ref LE_ECALL_STATE_ALACK_RECEIVED_CLEAR_DOWN is received
98  * - or the event @ref LE_ECALL_STATE_DISCONNECTED is received and no redial is launched (see
99  * @ref le_ecall_redial section for more information about the redial process).
100  *
101  * When the eCall object is no longer needed, call le_ecall_Delete() to free all allocated
102  * resources associated with the object.
103  *
104  * The current state of an eCall session can be queried using le_ecall_GetState().
105  * Alternatively, an application can register a handler be notified when the session state
106  * changes. The handler can be managed using le_ecall_AddStateChangeHandler() and
107  * le_ecall_RemoveStateChangeHandler().
108  *
109  * An application can also call le_ecall_GetTerminationReason() to retrieve the reason of the call
110  * termination when call state is @ref LE_ECALL_STATE_DISCONNECTED, and also
111  * le_ecall_GetPlatformSpecificTerminationCode() to get platform specific termination code (refer
112  * to your platform documentation for further details).
113  *
114  * @section le_ecall_concurrency Concurrency
115  *
116  * If another application tries to use the eCall service while a session is already in progress, the
117  * le_ecall_StartManual(), le_ecall_StartAutomatic(), le_ecall_StartTest() functions will return a
118  * @c LE_BUSY error. The eCall session in progress won't be interrupted or disturbed. The
119  * application can follow the session progress with 'state' functions like le_ecall_GetState() and
120  * le_ecall_AddStateChangeHandler().
121  * A manual eCall can't interrupt an automatic eCall, and an automatic eCall can't interrupt a
122  * manual eCall.
123  *
124  * @section le_ecall_msd Minimum Set of Data (MSD)
125  *
126  * The dynamic values of the MSD can be set with:
127  * - le_ecall_SetMsdPosition() sets the position of the vehicle.
128  * - le_ecall_SetMsdPositionN1() sets the first delta position of the vehicle.
129  * - le_ecall_SetMsdPositionN2() sets the second delta position of the vehicle.
130  * - le_ecall_SetMsdPassengersCount() sets the number of passengers.
131  *
132  * The MSD is automatically encoded with the values previously set.
133  *
134  * @warning Those functions return a LE_DUPLICATE error when the MSD has been already imported with
135  * le_ecall_ImportMsd() function.
136  *
137  * The MSD transmission mode can be set or get with:
138  * - le_ecall_SetMsdTxMode()
139  * - le_ecall_GetMsdTxMode()
140  *
141  * The transmission mode can be:
142  * - @c LE_ECALL_TX_MODE_PUSH : the MSD is pushed by the IVS
143  * - @c LE_ECALL_TX_MODE_PULL : the MSD is sent when requested by the PSAP
144  *
145  * It's possible to import a prepared MSD using the le_ecall_ImportMsd() function.
146  * The prepared MSD must answer the requirements described in the "EN 15722:2013" publication (this
147  * publication has been prepared by Technical Committee CEN/TC 278 “Intelligent Transport Systems").
148  *
149  * @warning The imported MSD doesn't take into account the values provided by the
150  * le_ecall_SetMsdXxx() functions. It overwrites any previous imported MSD or encoded MSD.
151  *
152  * @warning The imported MSD overwrites the control flags (automaticActivation and testCall) set by
153  * le_ecall_StartXxx() functions (Manual, Automatic, Test). The User App is in charge of their
154  * correct settings.
155  *
156  * The encoded MSD can be retrieved with le_ecall_ExportMsd() function.
157  *
158  * @note The User app must perform the MSD transmission by calling le_ecall_SendMsd() when the
159  * LE_ECALL_STATE_PSAP_START_IND_RECEIVED event is received.
160  * The MSD can be updated before calling le_ecall_SendMsd(), using the e_ecall_ImportMsd() function
161  * or the le_ecall_SetMsdXxx() functions.
162  *
163  * @section le_ecall_eraglonass ERA-GLONASS compliancy
164  *
165  * To perform an emergency call following the ERA-GLONASS requirements, the 'systemStandard' entry
166  * of the configuration database must be set to 'ERA-GLONASS'.
167  *
168  * Moreover, the User can set some specific configuration settings in accordance with the PSAP
169  * configuration:
170  *
171  * - le_ecall_SetEraGlonassManualDialAttempts(): set the MANUAL_DIAL_ATTEMPTS value. If a dial
172  * attempt under manual emergency call initiation failed, it should be repeated maximally
173  * ECALL_MANUAL_DIAL_ATTEMPTS-1 times within the maximal time limit of ECALL_DIAL_DURATION.
174  * The default value is 10.
175  * Redial attempts stop once the call has been cleared down correctly, or if counter / timer
176  * reached their limits.
177  * Available for both manual and test modes.
178  * - le_ecall_SetEraGlonassAutoDialAttempts(): set the AUTO_DIAL_ATTEMPTS value. If a dial attempt
179  * under automatic emergency call initiation failed, it should be repeated maximally
180  * ECALL_AUTO_DIAL_ATTEMPTS-1 times within the maximal time limit of ECALL_DIAL_DURATION.
181  * The default value is 10.
182  * Redial attempts stop once the call has been cleared down correctly, or if counter / timer
183  * reached their limits.
184  * - le_ecall_SetEraGlonassDialDuration(): set the ECALL_DIAL_DURATION time. It is the maximum time
185  * the IVS have to connect the emergency call to the PSAP, including all redial attempts.
186  * If the call is not connected within this time (or ManualDialAttempts/AutoDialAttempts dial
187  * attempts), it will stop.
188  *
189  * The corresponding getter functions let you retrieve the configuration settings values:
190  *
191  * - le_ecall_GetEraGlonassManualDialAttempts(): get the MANUAL_DIAL_ATTEMPTS value.
192  * - le_ecall_GetEraGlonassAutoDialAttempts(): get the AUTO_DIAL_ATTEMPTS value.
193  * - le_ecall_GetEraGlonassDialDuration(): get the ECALL_DIAL_DURATION time.
194  *
195  * @section le_ecall_eraGlonassData ERA-GLONASS MSD additional data
196  *
197  * ERA-GLONASS additional data are optional and provided in the MSD message if any.
198  * They are located in MSD data block number 12 as optional additional data.
199  *
200  * ERA-GLONASS MSD additional data describes:
201  * - The crash severity (Accident Severity Index - ASI15)
202  * - The diagnostic result
203  * - The crash information
204  *
205  * ERA-GLONASS MSD additional data can be specified through the following functions:
206  * - le_ecall_SetMsdEraGlonassCrashSeverity().
207  * - le_ecall_ResetMsdEraGlonassCrashSeverity().
208  * - le_ecall_SetMsdEraGlonassDiagnosticResult().
209  * - le_ecall_ResetMsdEraGlonassDiagnosticResult().
210  * - le_ecall_SetMsdEraGlonassCrashInfo().
211  * - le_ecall_ResetMsdEraGlonassCrashInfo().
212  *
213  * ERA-GLONASS additional data is encoded using the OID version "1.4.1".
214  * This was assigned to ERA-GLONASS optional additional data by CEN. Content of data
215  * block in the AdditionalData should be:
216  *
217  * @code
218  *
219  * ERAOADASN1Module
220  * DEFINITIONS
221  * AUTOMATIC TAGS ::=
222  * BEGIN
223  * ERADataFormatId::= INTEGER (1)
224  *
225  * ERAAdditionalData ::= SEQUENCE {
226  * crashSeverity INTEGER(0..2047) OPTIONAL,
227  * diagnosticResult DiagnosticResult OPTIONAL,
228  * crashInfo CrashInfo OPTIONAL,
229  * ...
230  * }
231  *
232  * DiagnosticResult ::= SEQUENCE {
233  * micConnectionFailure BOOLEAN OPTIONAL,
234  * micFailure BOOLEAN OPTIONAL,
235  * rightSpeakerFailure BOOLEAN OPTIONAL,
236  * leftSpeakerFailure BOOLEAN OPTIONAL,
237  * speakersFailure BOOLEAN OPTIONAL,
238  * ignitionLineFailure BOOLEAN OPTIONAL,
239  * uimFailure BOOLEAN OPTIONAL,
240  * statusIndicatorFailure BOOLEAN OPTIONAL,
241  * batteryFailure BOOLEAN OPTIONAL,
242  * batteryVoltageLow BOOLEAN OPTIONAL,
243  * crashSensorFailure BOOLEAN OPTIONAL,
244  * firmwareImageCorruption BOOLEAN OPTIONAL,
245  * commModuleInterfaceFailure BOOLEAN OPTIONAL,
246  * gnssReceiverFailure BOOLEAN OPTIONAL,
247  * raimProblem BOOLEAN OPTIONAL,
248  * gnssAntennaFailure BOOLEAN OPTIONAL,
249  * commModuleFailure BOOLEAN OPTIONAL,
250  * eventsMemoryOverflow BOOLEAN OPTIONAL,
251  * crashProfileMemoryOverflow BOOLEAN OPTIONAL,
252  * otherCriticalFailires BOOLEAN OPTIONAL,
253  * otherNotCriticalFailures BOOLEAN OPTIONAL
254  * }
255  *
256  * CrashInfo ::= SEQUENCE {
257  * crashFront BOOLEAN OPTIONAL,
258  * crashLeft BOOLEAN OPTIONAL,
259  * crashRight BOOLEAN OPTIONAL,
260  * crashRear BOOLEAN OPTIONAL,
261  * crashRollover BOOLEAN OPTIONAL,
262  * crashSide BOOLEAN OPTIONAL,
263  * crashFrontOrSide BOOLEAN OPTIONAL,
264  * crashAnotherType BOOLEAN OPTIONAL
265  * }
266  * END
267  * @endcode
268  *
269  * @section le_ecall_redial Redial management
270  *
271  * In the case of PAN-EUROPEAN, the redial can be performed as many times as desired but should be
272  * performed within 2 minutes. (EN 16062:2014 -7.14.3).
273  *
274  * In the case of ERA-GLONASS, the redial can be performed ECALL_MANUAL_DIAL_ATTEMPTS times within
275  * the maximal time limit of ECALL_DIAL_DURATION (GOST 54620 2013 -- Appendix A).
276  *
277  * The \b LE_ECALL_STATE_END_OF_REDIAL_PERIOD state event notifies the User of the redial period
278  * end.
279  *
280  * @section le_ecall_samples Code samples
281  *
282  * A sample code that implements an eCall test session with a local voice prompt can be found in
283  * \b eCallWPrompt.c file (please refer to @ref c_ecallWPromptSample page).
284  *
285  * A sample code that implements an eCall test session with a voice call connection can be found in
286  * \b eCallWVoice.c file (please refer to @ref c_ecallWVoiceSample page).
287  *
288  * If you want to have a look at a more in-depth usage of these APIs, please refer to the
289  * @ref c_ecall.
290  *
291  * @section le_ecall_configuration eCall configuration
292  *
293  * By default, the number to dial is read from the FDN/SDN (Fixed Dialling Numbers/Service
294  * Dialling Numbers) of the U/SIM, depending upon the eCall operating mode.
295  *
296  * However, the PSAP telephone number can be specified and retrieved with:
297  * - le_ecall_SetPsapNumber()
298  * - le_ecall_GetPsapNumber()
299  *
300  * @note That PSAP number is not applied to Manually or Automatically initiated eCall. For those
301  * modes, an emergency call is launched.
302  *
303  * @warning These two functions don't modified the U/SIM content nor read the U/SIM content.
304  *
305  * le_ecall_UseUSimNumbers() function can be recalled to indicate the modem to read the number to
306  * dial from the FDN/SDN of the U/SIM, depending upon the eCall operating mode.
307  *
308  * The NAD (Network Access Device, i.e. the Modem) deregistration time value can be set or get with:
309  * - le_ecall_SetNadDeregistrationTime()
310  * - le_ecall_GetNadDeregistrationTime()
311  *
312  * Time is set in hours where:
313  * - from 1 to 60 minutes -> 1 hour
314  * - from 61 to 120 minutes -> 2hours, etc.
315  *
316  * Example: if @c deregTime parameter unit is minutes, the effective time is:
317  * @code ECallConfiguration.nad_deregistration_time = (deregTime+59)/60; @endcode
318  *
319  * After termination of an emergency call the in-vehicle system remains registered on the network
320  * for the period of time, defined by the installation parameter 'NAD_DEREGISTRATION_TIME'.
321  *
322  * @warning Be sure to check the possible values of 'NAD_DEREGISTRATION_TIME' for your specific
323  * platform.
324  *
325  * The minimum interval value between dial attempts can be set or get with:
326  * - le_ecall_SetIntervalBetweenDialAttempts()
327  * - le_ecall_GetIntervalBetweenDialAttempts()
328  *
329  * The default value is set to 30 seconds.
330  *
331  * The time is counted from the start of the first dial attempt.
332  *
333  * If more time has expired during the dial attempt, it will wait for 1 second to allow hangup
334  * before redialing.
335  *
336  * If less time has expired during the dial attempt, it will wait for
337  * (interval - 'dial attempt duration') seconds to allow hangup before redialing.
338  *
339  * In the case the call was connected, the redial will be immediate.
340  *
341  * le_ecall_SetIntervalBetweenDialAttempts() is available for both manual and test modes.
342  *
343  * The prefered system standard defaults to PAN-EUROPEAN
344  * It can be set an gotten with the following functions:
345  * - le_ecall_SetSystemStandard()
346  * - le_ecall_GetSystemStandard()
347  *
348  * The MSD version can be set and and gotten with the following functions:
349  * - le_ecall_SetMsdVersion()
350  * - le_ecall_GetMsdVersion()
351  *
352  * The vehicle type can be set and gotten with the following functions:
353  * - le_ecall_SetVehicleType()
354  * - le_ecall_GetVehicleType()
355  *
356  * The vehicle identifier can be set and gotten with the following functions:
357  * - le_ecall_SetVIN()
358  * - le_ecall_GetVIN()
359  *
360  * The propulsion type can be set and gotten with the following functions:
361  * - le_ecall_SetPropulsionType()
362  * - le_ecall_GetPropulsionType()
363  *
364  * <HR>
365  *
366  * Copyright (C) Sierra Wireless Inc.
367  */
368 /**
369  * @file le_ecall_interface.h
370  *
371  * Legato @ref c_ecall include file.
372  *
373  * Copyright (C) Sierra Wireless Inc.
374  */
375 /**
376  * @page c_ecallWPromptSample Sample code of an eCall test session with a local voice prompt
377  *
378  * @include "apps/test/modemServices/ecall/ecallWPrompt/eCallWPrompt/eCallWPrompt.c"
379  */
380 /**
381  * @page c_ecallWVoiceSample Sample code an eCall test session with a voice call connection
382  *
383  * @include "apps/test/modemServices/ecall/ecallWVoice/eCallWVoice/eCallWVoice.c"
384  */
385 
386 #ifndef LE_ECALL_INTERFACE_H_INCLUDE_GUARD
387 #define LE_ECALL_INTERFACE_H_INCLUDE_GUARD
388 
389 
390 #include "legato.h"
391 
392 // Interface specific includes
393 #include "le_mdmDefs_interface.h"
394 #include "le_mcc_interface.h"
395 
396 
397 //--------------------------------------------------------------------------------------------------
398 /**
399  * Type for handler called when a server disconnects.
400  */
401 //--------------------------------------------------------------------------------------------------
402 typedef void (*le_ecall_DisconnectHandler_t)(void *);
403 
404 //--------------------------------------------------------------------------------------------------
405 /**
406  *
407  * Connect the current client thread to the service providing this API. Block until the service is
408  * available.
409  *
410  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
411  * called before any other functions in this API. Normally, ConnectService is automatically called
412  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
413  *
414  * This function is created automatically.
415  */
416 //--------------------------------------------------------------------------------------------------
418 (
419  void
420 );
421 
422 //--------------------------------------------------------------------------------------------------
423 /**
424  *
425  * Try to connect the current client thread to the service providing this API. Return with an error
426  * if the service is not available.
427  *
428  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
429  * called before any other functions in this API. Normally, ConnectService is automatically called
430  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
431  *
432  * This function is created automatically.
433  *
434  * @return
435  * - LE_OK if the client connected successfully to the service.
436  * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is
437  * bound.
438  * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
439  * - LE_COMM_ERROR if the Service Directory cannot be reached.
440  */
441 //--------------------------------------------------------------------------------------------------
443 (
444  void
445 );
446 
447 //--------------------------------------------------------------------------------------------------
448 /**
449  * Set handler called when server disconnection is detected.
450  *
451  * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants
452  * to continue without exiting, it should call longjmp() from inside the handler.
453  */
454 //--------------------------------------------------------------------------------------------------
456 (
457  le_ecall_DisconnectHandler_t disconnectHandler,
458  void *contextPtr
459 );
460 
461 //--------------------------------------------------------------------------------------------------
462 /**
463  *
464  * Disconnect the current client thread from the service providing this API.
465  *
466  * Normally, this function doesn't need to be called. After this function is called, there's no
467  * longer a connection to the service, and the functions in this API can't be used. For details, see
468  * @ref apiFilesC_client.
469  *
470  * This function is created automatically.
471  */
472 //--------------------------------------------------------------------------------------------------
474 (
475  void
476 );
477 
478 
479 //--------------------------------------------------------------------------------------------------
480 /**
481  * MSD message length in bytes.
482  */
483 //--------------------------------------------------------------------------------------------------
484 #define LE_ECALL_MSD_MAX_LEN 140
485 
486 //--------------------------------------------------------------------------------------------------
487 /**
488  * Vehicle Identification Number (VIN) string LENGTH. (without nulltermination)
489  */
490 //--------------------------------------------------------------------------------------------------
491 #define LE_ECALL_VIN_MAX_LEN 17
492 
493 //--------------------------------------------------------------------------------------------------
494 /**
495  * Vehicle Identification Number (VIN) string BYTES. One extra byte is added for the null
496  * character.
497  */
498 //--------------------------------------------------------------------------------------------------
499 #define LE_ECALL_VIN_MAX_BYTES 18
500 
501 //--------------------------------------------------------------------------------------------------
502 /**
503  * Reference returned by Create function and used by other functions
504  */
505 //--------------------------------------------------------------------------------------------------
506 typedef struct le_ecall_Call* le_ecall_CallRef_t;
507 
508 
509 //--------------------------------------------------------------------------------------------------
510 /**
511  * Configured operation modes.
512  */
513 //--------------------------------------------------------------------------------------------------
514 typedef enum
515 {
517  ///< Normal mode.
519  ///< eCall only mode according to U/SIM operation mode or forced
520  ///< by application through the le_ecall_ForceOnlyMode() function.
522  ///< Persistent eCall only mode.
523 }
525 
526 
527 //--------------------------------------------------------------------------------------------------
528 /**
529  * Configure which standard to follow for the eCall, either PAN European eCall or ERA GLONASS.
530  */
531 //--------------------------------------------------------------------------------------------------
532 typedef enum
533 {
535  ///< PAN-EUROPEAN standard
537  ///< ERA GLONASS standard
538 }
540 
541 
542 //--------------------------------------------------------------------------------------------------
543 /**
544  * eCall session states.
545  */
546 //--------------------------------------------------------------------------------------------------
547 typedef enum
548 {
550  ///< Unknown state.
552  ///< eCall session started.
554  ///< Emergency call is established.
556  ///< Emergency call is disconnected.
558  ///< Waiting for PSAP start indication.
560  ///< PSAP start indication received.
562  ///< MSD transmission is started.
564  ///< LL-NACK received.
566  ///< LL-ACK received.
568  ///< MSD transmission is complete.
570  ///< MSD transmission has failed.
572  ///< AL-ACK received.
574  ///< AL-ACK clear-down received.
576  ///< eCall session has been stopped by PSAP
577  ///< or IVS le_ecall_End().
579  ///< eCall session has lost synchronization and starts over.
581  ///< eCall session completed. The modem successfully completed
582  ///< the MSD transmission and received two AL-ACKs (positive).
583  ///< Can now switch to voice path.
585  ///< Unsuccessful eCall session.
587  ///< End of the redial period.
589  ///< Timeout for Timer T2 (see CEN-EN 16062, annex A)
591  ///< Timeout for Timer T3 (see CEN-EN 16062, annex A)
593  ///< Timeout for Timer T5 (see CEN-EN 16062, annex A)
595  ///< Timeout for Timer T6 (see CEN-EN 16062, annex A)
597  ///< Timeout for Timer T7 (see CEN-EN 16062, annex A)
599  ///< Timeout for Timer T9 (see CEN-EN 16062, annex A)
601  ///< Timeout for Timer T10 (see CEN-EN 16062, annex A)
602 }
604 
605 
606 //--------------------------------------------------------------------------------------------------
607 /**
608  * eCall MSD transmission mode.
609  */
610 //--------------------------------------------------------------------------------------------------
611 typedef enum
612 {
614  ///< Pull mode (modem/host waits for MSD request from PSAP to send MSD).
616  ///< Push mode (modem/host sends MSD to PSAP right after eCall is connected).
617 }
619 
620 
621 //--------------------------------------------------------------------------------------------------
622 /**
623  * eCall MSD vehicle type
624  */
625 //--------------------------------------------------------------------------------------------------
626 typedef enum
627 {
629  ///< Passenger vehicle (Class M1)
631  ///< Buses and coaches (Class M2)
633  ///< Buses and coaches (Class M3)
635  ///< Light commercial vehicles (Class N1)
637  ///< Heavy duty vehicles (Class N2)
639  ///< Heavy duty vehicles (Class N3)
641  ///< Motorcycles (Class L1e)
643  ///< Motorcycles (Class L2e)
645  ///< Motorcycles (Class L3e)
647  ///< Motorcycles (Class L4e)
649  ///< Motorcycles (Class L5e)
651  ///< Motorcycles (Class L6e)
653  ///< Motorcycles (Class L7e)
654 }
656 
657 
658 //--------------------------------------------------------------------------------------------------
659 /**
660  * Propulsion type Bit Mask
661  */
662 //--------------------------------------------------------------------------------------------------
663 typedef enum
664 {
665  LE_ECALL_PROPULSION_TYPE_GASOLINE = 0x1, ///< Gasoline propulsion)
666  LE_ECALL_PROPULSION_TYPE_DIESEL = 0x2, ///< Diesel propulsion
667  LE_ECALL_PROPULSION_TYPE_NATURALGAS = 0x4, ///< Compressed natural gas propulsion
668  LE_ECALL_PROPULSION_TYPE_PROPANE = 0x8, ///< Liquid propane gas propulsion
669  LE_ECALL_PROPULSION_TYPE_ELECTRIC = 0x10, ///< Electric propulsion
670  LE_ECALL_PROPULSION_TYPE_HYDROGEN = 0x20, ///< Hydrogen propulsion
671  LE_ECALL_PROPULSION_TYPE_OTHER = 0x40 ///< Other type of propulsions
672 }
674 
675 
676 //--------------------------------------------------------------------------------------------------
677 /**
678  * Diagnostic result Bit Mask (64 bits)
679  *
680  */
681 //--------------------------------------------------------------------------------------------------
682 typedef enum
683 {
684  LE_ECALL_DIAG_RESULT_PRESENT_MIC_CONNECTION_FAILURE = 0x1, ///< Present Mic connection failure.
685  LE_ECALL_DIAG_RESULT_MIC_CONNECTION_FAILURE = 0x2, ///< Mic connection failure status.
686  LE_ECALL_DIAG_RESULT_PRESENT_MIC_FAILURE = 0x4, ///< Present Mic failure.
687  LE_ECALL_DIAG_RESULT_MIC_FAILURE = 0x8, ///< Mic failure status.
688  LE_ECALL_DIAG_RESULT_PRESENT_RIGHT_SPEAKER_FAILURE = 0x10, ///< Present Right speaker failure.
689  LE_ECALL_DIAG_RESULT_RIGHT_SPEAKER_FAILURE = 0x20, ///< Right speaker failure status.
690  LE_ECALL_DIAG_RESULT_PRESENT_LEFT_SPEAKER_FAILURE = 0x40, ///< Present Left speaker failure.
691  LE_ECALL_DIAG_RESULT_LEFT_SPEAKER_FAILURE = 0x80, ///< Left speaker failure status.
692  LE_ECALL_DIAG_RESULT_PRESENT_SPEAKERS_FAILURE = 0x100, ///< Present Speaker failure.
693  LE_ECALL_DIAG_RESULT_SPEAKERS_FAILURE = 0x200, ///< Speaker failure status.
694  LE_ECALL_DIAG_RESULT_PRESENT_IGNITION_LINE_FAILURE = 0x400, ///< Present Ignition line failure.
695  LE_ECALL_DIAG_RESULT_IGNITION_LINE_FAILURE = 0x800, ///< Ignition line failure status.
696  LE_ECALL_DIAG_RESULT_PRESENT_UIM_FAILURE = 0x1000, ///< Present UIM failure.
697  LE_ECALL_DIAG_RESULT_UIM_FAILURE = 0x2000, ///< UIM failure status.
698  LE_ECALL_DIAG_RESULT_PRESENT_STATUS_INDICATOR_FAILURE = 0x4000, ///< Present Status indicator failure.
699  LE_ECALL_DIAG_RESULT_STATUS_INDICATOR_FAILURE = 0x8000, ///< Status indicator failure status.
700  LE_ECALL_DIAG_RESULT_PRESENT_BATTERY_FAILURE = 0x10000, ///< Present Battery failure.
701  LE_ECALL_DIAG_RESULT_BATTERY_FAILURE = 0x20000, ///< Battery failure status.
702  LE_ECALL_DIAG_RESULT_PRESENT_BATTERY_VOLTAGE_LOW = 0x40000, ///< Present Battery voltage low failure.
703  LE_ECALL_DIAG_RESULT_BATTERY_VOLTAGE_LOW = 0x80000, ///< Battery voltage low failure status.
704  LE_ECALL_DIAG_RESULT_PRESENT_CRASH_SENSOR_FAILURE = 0x100000, ///< Present Crash sensor failure.
705  LE_ECALL_DIAG_RESULT_CRASH_SENSOR_FAILURE = 0x200000, ///< Crash sensor failure status.
706  LE_ECALL_DIAG_RESULT_PRESENT_FIRMWARE_IMAGE_CORRUPTION = 0x400000, ///< Present Firmware image corruption failure.
707  LE_ECALL_DIAG_RESULT_FIRMWARE_IMAGE_CORRUPTION = 0x800000, ///< Firmware image corruption failure status.
708  LE_ECALL_DIAG_RESULT_PRESENT_COMM_MODULE_INTERFACE_FAILURE = 0x1000000, ///< Present Comm module interface failure.
709  LE_ECALL_DIAG_RESULT_COMM_MODULE_INTERFACE_FAILURE = 0x2000000, ///< Comm module interface failure status.
710  LE_ECALL_DIAG_RESULT_PRESENT_GNSS_RECEIVER_FAILURE = 0x4000000, ///< Present GNSS receiver failure.
711  LE_ECALL_DIAG_RESULT_GNSS_RECEIVER_FAILURE = 0x8000000, ///< GNSS receiver failure status.
712  LE_ECALL_DIAG_RESULT_PRESENT_RAIM_PROBLEM = 0x10000000, ///< Present RAIM problem.
713  LE_ECALL_DIAG_RESULT_RAIM_PROBLEM = 0x20000000, ///< RAIM problem status.
714  LE_ECALL_DIAG_RESULT_PRESENT_GNSS_ANTENNA_FAILURE = 0x40000000, ///< Present GNSS antenna failure.
715  LE_ECALL_DIAG_RESULT_GNSS_ANTENNA_FAILURE = 0x80000000, ///< GNSS antenna failure status.
716  LE_ECALL_DIAG_RESULT_PRESENT_COMM_MODULE_FAILURE = 0x100000000, ///< Present Comm module failure.
717  LE_ECALL_DIAG_RESULT_COMM_MODULE_FAILURE = 0x200000000, ///< Comm module failure status.
718  LE_ECALL_DIAG_RESULT_PRESENT_EVENTS_MEMORY_OVERFLOW = 0x400000000, ///< Present Events memory overflow.
719  LE_ECALL_DIAG_RESULT_EVENTS_MEMORY_OVERFLOW = 0x800000000, ///< Events memory overflow status.
720  LE_ECALL_DIAG_RESULT_PRESENT_CRASH_PROFILE_MEMORY_OVERFLOW = 0x1000000000, ///< Present Crash profile memory overflow.
721  LE_ECALL_DIAG_RESULT_CRASH_PROFILE_MEMORY_OVERFLOW = 0x2000000000, ///< Crash profile memory overflow status.
722  LE_ECALL_DIAG_RESULT_PRESENT_OTHER_CRITICAL_FAILURES = 0x4000000000, ///< Present Other critical failures.
723  LE_ECALL_DIAG_RESULT_OTHER_CRITICAL_FAILURES = 0x8000000000, ///< Other critical failures status.
724  LE_ECALL_DIAG_RESULT_PRESENT_OTHER_NOT_CRITICAL_FAILURES = 0x10000000000, ///< Present Other not critical failures.
725  LE_ECALL_DIAG_RESULT_OTHER_NOT_CRITICAL_FAILURES = 0x20000000000 ///< Other not critical failures status.
726 }
728 
729 
730 //--------------------------------------------------------------------------------------------------
731 /**
732  * Crash information Bit Mask (16 bits) indicating the type of road accident.
733  *
734  */
735 //--------------------------------------------------------------------------------------------------
736 typedef enum
737 {
738  LE_ECALL_CRASH_INFO_PRESENT_CRASH_FRONT = 0x1, ///< Present Front collision indicator.
739  LE_ECALL_CRASH_INFO_CRASH_FRONT = 0x2, ///< Front collision indicator.
740  LE_ECALL_CRASH_INFO_PRESENT_CRASH_LEFT = 0x4, ///< Present Left collision indicator.
741  LE_ECALL_CRASH_INFO_CRASH_LEFT = 0x8, ///< Left collision indicator.
742  LE_ECALL_CRASH_INFO_PRESENT_CRASH_RIGHT = 0x10, ///< Present Right collision indicator
743  LE_ECALL_CRASH_INFO_CRASH_RIGHT = 0x20, ///< Right collision indicator
744  LE_ECALL_CRASH_INFO_PRESENT_CRASH_REAR = 0x40, ///< Present indicator
745  LE_ECALL_CRASH_INFO_CRASH_REAR = 0x80, ///< Rear impact indicator.
746  LE_ECALL_CRASH_INFO_PRESENT_CRASH_ROLLOVER = 0x100, ///< Present Rollover indicator.
747  LE_ECALL_CRASH_INFO_CRASH_ROLLOVER = 0x200, ///< Rollover indicator.
748  LE_ECALL_CRASH_INFO_PRESENT_CRASH_SIDE = 0x400, ///< Present Side collision indicator.
749  LE_ECALL_CRASH_INFO_CRASH_SIDE = 0x800, ///< Side collision indicator.
750  LE_ECALL_CRASH_INFO_PRESENT_CRASH_FRONT_OR_SIDE = 0x1000, ///< Present Front or side collision indicator.
751  LE_ECALL_CRASH_INFO_CRASH_FRONT_OR_SIDE = 0x2000, ///< Front or side collision indicator.
752  LE_ECALL_CRASH_INFO_PRESENT_CRASH_ANOTHER_TYPE = 0x4000, ///< Present Other types of damage indicator.
753  LE_ECALL_CRASH_INFO_CRASH_ANOTHER_TYPE = 0x8000 ///< Other types of damage indicator.
754 }
756 
757 
758 //--------------------------------------------------------------------------------------------------
759 /**
760  * Reference type used by Add/Remove functions for EVENT 'le_ecall_StateChange'
761  */
762 //--------------------------------------------------------------------------------------------------
763 typedef struct le_ecall_StateChangeHandler* le_ecall_StateChangeHandlerRef_t;
764 
765 
766 //--------------------------------------------------------------------------------------------------
767 /**
768  * Handler for eCall state changes.
769  *
770  */
771 //--------------------------------------------------------------------------------------------------
772 typedef void (*le_ecall_StateChangeHandlerFunc_t)
773 (
774  le_ecall_CallRef_t ecallRef,
775  ///< eCall reference
776  le_ecall_State_t state,
777  ///< eCall state
778  void* contextPtr
779  ///<
780 );
781 
782 //--------------------------------------------------------------------------------------------------
783 /**
784  * This function configures the eCall operation mode to eCall only, only emergency number can be
785  * used to start an eCall session. The modem doesn't try to register on the Cellular network.
786  * This function forces the modem to behave as eCall only mode whatever U/SIM operation mode.
787  * The change doesn't persist over power cycles.
788  * This function can be called before making an eCall.
789  *
790  * @return
791  * - LE_OK on success
792  * - LE_FAULT for other failures
793  */
794 //--------------------------------------------------------------------------------------------------
796 (
797  void
798 );
799 
800 //--------------------------------------------------------------------------------------------------
801 /**
802  * Same as le_ecall_ForceOnlyMode(), but the change persists over power cycles.
803  *
804  * @return
805  * - LE_OK on success
806  * - LE_FAULT for other failures
807  */
808 //--------------------------------------------------------------------------------------------------
810 (
811  void
812 );
813 
814 //--------------------------------------------------------------------------------------------------
815 /**
816  * This function exits from eCall Only mode. It configures the eCall operation mode to Normal mode,
817  * the modem uses the default operation mode at power up (or after U/SIM hotswap). The modem behaves
818  * following the U/SIM eCall operation mode; for example the U/SIM can be configured only for eCall,
819  * or a combination of eCall and commercial service provision.
820  *
821  * @return
822  * - LE_OK on success
823  * - LE_FAULT for other failures
824  */
825 //--------------------------------------------------------------------------------------------------
827 (
828  void
829 );
830 
831 //--------------------------------------------------------------------------------------------------
832 /**
833  * Get the configured Operation mode.
834  *
835  * @return
836  * - LE_OK on success
837  * - LE_FAULT for other failures
838  */
839 //--------------------------------------------------------------------------------------------------
841 (
842  le_ecall_OpMode_t* opModePtr
843  ///< [OUT] Operation mode
844 );
845 
846 //--------------------------------------------------------------------------------------------------
847 /**
848  * Add handler function for EVENT 'le_ecall_StateChange'
849  *
850  * This event provides information on eCall state changes.
851  *
852  */
853 //--------------------------------------------------------------------------------------------------
855 (
857  ///< [IN]
858  void* contextPtr
859  ///< [IN]
860 );
861 
862 //--------------------------------------------------------------------------------------------------
863 /**
864  * Remove handler function for EVENT 'le_ecall_StateChange'
865  */
866 //--------------------------------------------------------------------------------------------------
868 (
870  ///< [IN]
871 );
872 
873 //--------------------------------------------------------------------------------------------------
874 /**
875  * Create a new eCall object
876  *
877  * The eCall is not actually established at this point. It's still up to the caller to call
878  * le_ecall_Start() when ready.
879  *
880  * @return
881  * - A reference to the new Call object.
882  *
883  * @note On failure, the process exits; you don't have to worry about checking the returned
884  * reference for validity.
885  */
886 //--------------------------------------------------------------------------------------------------
888 (
889  void
890 );
891 
892 //--------------------------------------------------------------------------------------------------
893 /**
894  * Call to free up a call reference.
895  *
896  * @note This will free the reference, but not necessarily stop an active eCall. If there are
897  * other holders of this reference the eCall will remain active.
898  */
899 //--------------------------------------------------------------------------------------------------
900 void le_ecall_Delete
901 (
902  le_ecall_CallRef_t ecallRef
903  ///< [IN] eCall reference
904 );
905 
906 //--------------------------------------------------------------------------------------------------
907 /**
908  * Set the system standard.
909  * Default is PAN EUROPEAN
910  *
911  * @return
912  * - LE_OK on success
913  * - LE_FAULT for other failures
914  */
915 //--------------------------------------------------------------------------------------------------
917 (
918  le_ecall_SystemStandard_t systemStandard
919  ///< [IN] System standard
920 );
921 
922 //--------------------------------------------------------------------------------------------------
923 /**
924  * Get the system standard.
925  *
926  * @return
927  * - LE_OK on success
928  * - LE_FAULT for other failures
929  * - LE_BAD_PARAMETER parameter is NULL
930  */
931 //--------------------------------------------------------------------------------------------------
933 (
934  le_ecall_SystemStandard_t* systemStandardPtr
935  ///< [OUT] System Standard
936 );
937 
938 //--------------------------------------------------------------------------------------------------
939 /**
940  * Set the MSDs version.
941  * Default value is 1
942  *
943  * @return
944  * - LE_OK on success
945  * - LE_FAULT for other failures
946  */
947 //--------------------------------------------------------------------------------------------------
949 (
950  uint32_t msdVersion
951  ///< [IN] Msd version
952 );
953 
954 //--------------------------------------------------------------------------------------------------
955 /**
956  * Get the MSD version.
957  *
958  * @return
959  * - LE_OK on success
960  * - LE_FAULT for other failures
961  * - LE_BAD_PARAMETER parameter is NULL
962  */
963 //--------------------------------------------------------------------------------------------------
965 (
966  uint32_t* msdVersionPtr
967  ///< [OUT] Msd version
968 );
969 
970 //--------------------------------------------------------------------------------------------------
971 /**
972  * Set the Vehicled Type
973  * Default value is 0
974  *
975  * @return
976  * - LE_OK on success
977  * - LE_FAULT for other failures
978  */
979 //--------------------------------------------------------------------------------------------------
981 (
982  le_ecall_MsdVehicleType_t vehicleType
983  ///< [IN] Vehicle type
984 );
985 
986 //--------------------------------------------------------------------------------------------------
987 /**
988  * Get the Vehicled Type.
989  *
990  * @return
991  * - LE_OK on success
992  * - LE_BAD_PARAMETER parameter is NULL
993  * - LE_FAULT for other failures
994  */
995 //--------------------------------------------------------------------------------------------------
997 (
998  le_ecall_MsdVehicleType_t* vehicleTypePtr
999  ///< [OUT] Vehicle type
1000 );
1001 
1002 //--------------------------------------------------------------------------------------------------
1003 /**
1004  * Set the VIN (Vehicle Identification Number).
1005  *
1006  * @return
1007  * - LE_OK on success
1008  * - LE_BAD_PARAMETER parameter is NULL.
1009  * - LE_FAULT for other failures
1010  */
1011 //--------------------------------------------------------------------------------------------------
1013 (
1014  const char* vin
1015  ///< [IN] VIN (Vehicle Identification Number)
1016 )
1017 __attribute__(( nonnull(1) ));
1018 
1019 //--------------------------------------------------------------------------------------------------
1020 /**
1021  * Get the VIN (Vehicle Identification Number).
1022  *
1023  * @return
1024  * - LE_OK on success
1025  * - LE_NOT_FOUND if the value is not set.
1026  * - LE_BAD_PARAMETER parameter is NULL or to small
1027  * - LE_FAULT for other failures
1028  */
1029 //--------------------------------------------------------------------------------------------------
1031 (
1032  char* vin,
1033  ///< [OUT] VIN is gotten with a null termination.
1034  size_t vinSize
1035  ///< [IN]
1036 );
1037 
1038 //--------------------------------------------------------------------------------------------------
1039 /**
1040  * Set the propulsion type.
1041  * Note that a vehicle may have more than one propulsion type.
1042  *
1043  * @return
1044  * - LE_OK on success
1045  * - LE_FAULT for other failures
1046  */
1047 //--------------------------------------------------------------------------------------------------
1049 (
1050  le_ecall_PropulsionTypeBitMask_t propulsionType
1051  ///< [IN] bitmask
1052 );
1053 
1054 //--------------------------------------------------------------------------------------------------
1055 /**
1056  * Get the propulsion stored.
1057  * Note that a vehicle may have more than one propulsion type.
1058  *
1059  * @return
1060  * - LE_OK on success
1061  * - LE_NOT_FOUND if the value is not set.
1062  * - LE_FAULT for other failures
1063  * - LE_BAD_PARAMETER parameter is NULL
1064  */
1065 //--------------------------------------------------------------------------------------------------
1067 (
1068  le_ecall_PropulsionTypeBitMask_t* propulsionTypePtr
1069  ///< [OUT] bitmask
1070 );
1071 
1072 //--------------------------------------------------------------------------------------------------
1073 /**
1074  * Set the push/pull transmission mode.
1075  *
1076  * @return
1077  * - LE_OK on success
1078  * - LE_FAULT for other failures
1079  */
1080 //--------------------------------------------------------------------------------------------------
1082 (
1084  ///< [IN] Transmission mode
1085 );
1086 
1087 //--------------------------------------------------------------------------------------------------
1088 /**
1089  * Get the push/pull transmission mode.
1090  *
1091  * @return
1092  * - LE_OK on success
1093  * - LE_FAULT for other failures
1094  */
1095 //--------------------------------------------------------------------------------------------------
1097 (
1098  le_ecall_MsdTxMode_t* modePtr
1099  ///< [OUT] Transmission mode
1100 );
1101 
1102 //--------------------------------------------------------------------------------------------------
1103 /**
1104  * Set the position transmitted by the MSD.
1105  *
1106  * @return
1107  * - LE_OK on success
1108  * - LE_DUPLICATE an MSD has been already imported
1109  * - LE_BAD_PARAMETER bad input parameter
1110  * - LE_FAULT on other failures
1111  *
1112  * @note The process exits, if an invalid eCall reference is given
1113  */
1114 //--------------------------------------------------------------------------------------------------
1116 (
1117  le_ecall_CallRef_t ecallRef,
1118  ///< [IN] eCall reference
1119  bool isTrusted,
1120  ///< [IN] true if the position is accurate, false otherwise
1121  int32_t latitude,
1122  ///< [IN] latitude in degrees with 6 decimal places, positive North.
1123  ///< Maximum value is +90 degrees (+90000000), minimum value is -90
1124  ///< degrees (-90000000).
1125  int32_t longitude,
1126  ///< [IN] longitude in degrees with 6 decimal places, positive East.
1127  ///< Maximum value is +180 degrees (+180000000), minimum value is
1128  ///< -180 degrees (-180000000).
1129  int32_t direction
1130  ///< [IN] direction of the vehicle from magnetic north (0 to 358, clockwise)
1131  ///< in 2-degrees unit. Valid range is 0 to 179. If direction of
1132  ///< travel is invalid or unknown, the value 0xFF shall be used.
1133 );
1134 
1135 //--------------------------------------------------------------------------------------------------
1136 /**
1137  * Set the position Delta N-1 from position set in le_ecall_SetMsdPosition() transmitted by the MSD.
1138  *
1139  * @return
1140  * - LE_OK on success
1141  * - LE_DUPLICATE an MSD has been already imported
1142  * - LE_BAD_PARAMETER bad input parameter
1143  * - LE_FAULT on other failures
1144  *
1145  * @note The process exits, if an invalid eCall reference is given
1146  */
1147 //--------------------------------------------------------------------------------------------------
1149 (
1150  le_ecall_CallRef_t ecallRef,
1151  ///< [IN] eCall reference
1152  int32_t latitudeDeltaN1,
1153  ///< [IN] longitude delta from position set in SetMsdPosition
1154  ///< 1 Unit = 100 miliarcseconds, which is approximately 3m
1155  ///< maximum value: 511 = 0 0'51.100'' (+- 1580m)
1156  ///< minimum value: -512 = -0 0'51.200'' (+- -1583m)
1157  int32_t longitudeDeltaN1
1158  ///< [IN] longitude delta from position set in SetMsdPosition
1159  ///< 1 Unit = 100 miliarcseconds, which is approximately 3m
1160  ///< maximum value: 511 = 0 0'51.100'' (+-1580m)
1161  ///< minimum value: -512 = -0 0'51.200'' (+- -1583m) )
1162 );
1163 
1164 //--------------------------------------------------------------------------------------------------
1165 /**
1166  * Set the position Delta N-2 from position set in le_ecall_SetMsdPositionN1() transmitted by the MSD.
1167  *
1168  * @return
1169  * - LE_OK on success
1170  * - LE_DUPLICATE an MSD has been already imported
1171  * - LE_BAD_PARAMETER bad input parameter
1172  * - LE_FAULT on other failures
1173  *
1174  * @note The process exits, if an invalid eCall reference is given
1175  */
1176 //--------------------------------------------------------------------------------------------------
1178 (
1179  le_ecall_CallRef_t ecallRef,
1180  ///< [IN] eCall reference
1181  int32_t latitudeDeltaN2,
1182  ///< [IN] longitude delta from position set in SetMsdPositionN1
1183  ///< 1 Unit = 100 miliarcseconds, which is approximately 3m
1184  ///< maximum value: 511 = 0 0'51.100'' (+-1580m)
1185  ///< minimum value: -512 = -0 0'51.200'' (+- -1583m)
1186  int32_t longitudeDeltaN2
1187  ///< [IN] longitude delta from position set in SetMsdPositionN1
1188  ///< 1 Unit = 100 miliarcseconds, which is approximately 3m
1189  ///< maximum value: 511 = 0 0'51.100'' (+-1580m)
1190  ///< minimum value: -512 = -0 0'51.200'' (+- -1583m) )
1191 );
1192 
1193 //--------------------------------------------------------------------------------------------------
1194 /**
1195  * Set the number of passengers transmitted by the MSD.
1196  *
1197  * @return
1198  * - LE_OK on success
1199  * - LE_DUPLICATE an MSD has been already imported
1200  * - LE_BAD_PARAMETER bad eCall reference
1201  *
1202  * @note The process exits, if an invalid eCall reference is given
1203  */
1204 //--------------------------------------------------------------------------------------------------
1206 (
1207  le_ecall_CallRef_t ecallRef,
1208  ///< [IN] eCall reference
1209  uint32_t paxCount
1210  ///< [IN] number of passengers
1211 );
1212 
1213 //--------------------------------------------------------------------------------------------------
1214 /**
1215  * Import an already prepared MSD.
1216  *
1217  * MSD is transmitted only after an emergency call has been established.
1218  *
1219  * @return
1220  * - LE_OK on success
1221  * - LE_OVERFLOW The imported MSD length exceeds the MSD_MAX_LEN maximum length.
1222  * - LE_BAD_PARAMETER bad eCall reference
1223  * - LE_FAULT for other failures
1224  *
1225  * @note On failure, the process exits; you don't have to worry about checking the returned
1226  * reference for validity.
1227  */
1228 //--------------------------------------------------------------------------------------------------
1230 (
1231  le_ecall_CallRef_t ecallRef,
1232  ///< [IN] eCall reference
1233  const uint8_t* msdPtr,
1234  ///< [IN] the prepared MSD
1235  size_t msdSize
1236  ///< [IN]
1237 );
1238 
1239 //--------------------------------------------------------------------------------------------------
1240 /**
1241  * Export the encoded MSD.
1242  *
1243  * @return
1244  * - LE_OK on success
1245  * - LE_OVERFLOW The encoded MSD length exceeds the user's buffer length.
1246  * - LE_NOT_FOUND No encoded MSD is available.
1247  * - LE_BAD_PARAMETER bad eCall reference.
1248  * - LE_FAULT for other failures.
1249  *
1250  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
1251  * function will not return.
1252  */
1253 //--------------------------------------------------------------------------------------------------
1255 (
1256  le_ecall_CallRef_t ecallRef,
1257  ///< [IN] eCall reference
1258  uint8_t* msdPtr,
1259  ///< [OUT] the encoded MSD
1260  size_t* msdSizePtr
1261  ///< [INOUT]
1262 );
1263 
1264 //--------------------------------------------------------------------------------------------------
1265 /**
1266  * Send the MSD.
1267  *
1268  * @return
1269  * - LE_OK on success
1270  * - LE_BAD_PARAMETER bad eCall reference
1271  * - LE_FAULT for other failures
1272  *
1273  * @note On failure, the process exits, so you don't have to worry about checking the returned
1274  * reference for validity.
1275  */
1276 //--------------------------------------------------------------------------------------------------
1278 (
1279  le_ecall_CallRef_t ecallRef
1280  ///< [IN] eCall reference
1281 );
1282 
1283 //--------------------------------------------------------------------------------------------------
1284 /**
1285  * Start an automatic eCall session
1286  *
1287  * @return
1288  * - LE_OK on success
1289  * - LE_BUSY an eCall session is already in progress
1290  * - LE_BAD_PARAMETER bad eCall reference
1291  * - LE_FAULT for other failures
1292  *
1293  * @note The process exits, if an invalid eCall reference is given
1294  */
1295 //--------------------------------------------------------------------------------------------------
1297 (
1298  le_ecall_CallRef_t ecallRef
1299  ///< [IN] eCall reference
1300 );
1301 
1302 //--------------------------------------------------------------------------------------------------
1303 /**
1304  * Start a manual eCall session
1305  *
1306  * @return
1307  * - LE_OK on success
1308  * - LE_BUSY an eCall session is already in progress
1309  * - LE_BAD_PARAMETER bad eCall reference
1310  * - LE_FAULT for other failures
1311  *
1312  * @note The process exits, if an invalid eCall reference is given
1313  */
1314 //--------------------------------------------------------------------------------------------------
1316 (
1317  le_ecall_CallRef_t ecallRef
1318  ///< [IN] eCall reference
1319 );
1320 
1321 //--------------------------------------------------------------------------------------------------
1322 /**
1323  * Start a test eCall session
1324  *
1325  * @return
1326  * - LE_OK on success
1327  * - LE_BUSY an eCall session is already in progress
1328  * - LE_BAD_PARAMETER bad eCall reference
1329  * - LE_FAULT for other failures
1330  *
1331  * @note The process exits, if an invalid eCall reference is given
1332  */
1333 //--------------------------------------------------------------------------------------------------
1335 (
1336  le_ecall_CallRef_t ecallRef
1337  ///< [IN] eCall reference
1338 );
1339 
1340 //--------------------------------------------------------------------------------------------------
1341 /**
1342  * End the current eCall session
1343  *
1344  * @return
1345  * - LE_OK on success
1346  * - LE_BAD_PARAMETER bad eCall reference
1347  * - LE_FAULT for other failures
1348  */
1349 //--------------------------------------------------------------------------------------------------
1351 (
1352  le_ecall_CallRef_t ecallRef
1353  ///< [IN] eCall reference
1354 );
1355 
1356 //--------------------------------------------------------------------------------------------------
1357 /**
1358  * Get the current state for the given eCall
1359  *
1360  * @return
1361  * - The current state for the given eCall
1362  *
1363  * @note The process exits, if an invalid eCall reference is given
1364  */
1365 //--------------------------------------------------------------------------------------------------
1367 (
1368  le_ecall_CallRef_t ecallRef
1369  ///< [IN] eCall reference
1370 );
1371 
1372 //--------------------------------------------------------------------------------------------------
1373 /**
1374  * Set the Public Safely Answering Point telephone number.
1375  *
1376  * @note That PSAP number is not applied to Manually or Automatically initiated eCall. For those
1377  * modes, an emergency call is launched.
1378  *
1379  * @warning This function doesn't modified the U/SIM content.
1380  *
1381  * @return
1382  * - LE_OK on success
1383  * - LE_FAULT for other failures
1384  *
1385  * @note If PSAP number is too long (max LE_MDMDEFS_PHONE_NUM_MAX_LEN digits), it is a fatal error,
1386  * the function will not return.
1387  */
1388 //--------------------------------------------------------------------------------------------------
1390 (
1391  const char* psap
1392  ///< [IN] Public Safely Answering Point number
1393 )
1394 __attribute__(( nonnull(1) ));
1395 
1396 //--------------------------------------------------------------------------------------------------
1397 /**
1398  * Get the Public Safely Answering Point telephone number set with le_ecall_SetPsapNumber()
1399  * function.
1400  *
1401  * @note That PSAP number is not applied to Manually or Automatically initiated eCall. For those
1402  * modes, an emergency call is launched.
1403  *
1404  * @warning This function doesn't read the U/SIM content.
1405  *
1406  * @return
1407  * - LE_OK on success
1408  * - LE_FAULT on failures or if le_ecall_SetPsapNumber() has never been called before.
1409  */
1410 //--------------------------------------------------------------------------------------------------
1412 (
1413  char* psap,
1414  ///< [OUT] Public Safely Answering Point telephone number
1415  size_t psapSize
1416  ///< [IN]
1417 );
1418 
1419 //--------------------------------------------------------------------------------------------------
1420 /**
1421  * This function can be recalled to indicate the modem to read the number to dial from the FDN/SDN
1422  * of the U/SIM, depending upon the eCall operating mode.
1423  *
1424  * @return
1425  * - LE_OK on success
1426  * - LE_FAULT for other failures
1427  */
1428 //--------------------------------------------------------------------------------------------------
1430 (
1431  void
1432 );
1433 
1434 //--------------------------------------------------------------------------------------------------
1435 /**
1436  * Set the NAD_DEREGISTRATION_TIME value. After termination of an emergency call the in-vehicle
1437  * system remains registered on the network for the period of time, defined by the installation
1438  * parameter NAD_DEREGISTRATION_TIME.
1439  *
1440  * @return
1441  * - LE_OK on success
1442  * - LE_FAULT on failure
1443  */
1444 //--------------------------------------------------------------------------------------------------
1446 (
1447  uint16_t deregTime
1448  ///< [IN] the NAD_DEREGISTRATION_TIME value (in minutes).
1449 );
1450 
1451 //--------------------------------------------------------------------------------------------------
1452 /**
1453  * Get the NAD_DEREGISTRATION_TIME value.
1454  *
1455  * @return
1456  * - LE_OK on success
1457  * - LE_FAULT on failure
1458  */
1459 //--------------------------------------------------------------------------------------------------
1461 (
1462  uint16_t* deregTimePtr
1463  ///< [OUT] the NAD_DEREGISTRATION_TIME value (in minutes).
1464 );
1465 
1466 //--------------------------------------------------------------------------------------------------
1467 /**
1468  * Set the minimum interval value between dial attempts.
1469  *
1470  * @return
1471  * - LE_OK on success
1472  * - LE_FAULT for other failures
1473  */
1474 //--------------------------------------------------------------------------------------------------
1476 (
1477  uint16_t pause
1478  ///< [IN] the minimum interval value in seconds
1479 );
1480 
1481 //--------------------------------------------------------------------------------------------------
1482 /**
1483  * Get the minimum interval value between dial attempts.
1484  *
1485  * @return
1486  * - LE_OK on success
1487  * - LE_FAULT for other failures
1488  */
1489 //--------------------------------------------------------------------------------------------------
1491 (
1492  uint16_t* pausePtr
1493  ///< [OUT] the minimum interval value in seconds
1494 );
1495 
1496 //--------------------------------------------------------------------------------------------------
1497 /**
1498  * Set the MANUAL_DIAL_ATTEMPTS value. If a dial attempt under manual emergency call initiation
1499  * failed, it should be repeated maximally ECALL_MANUAL_DIAL_ATTEMPTS-1 times within the maximal
1500  * time limit of ECALL_DIAL_DURATION. The default value is 10.
1501  * Redial attempts stop once the call has been cleared down correctly, or if counter/timer reached
1502  * their limits.
1503  *
1504  * @return
1505  * - LE_OK on success
1506  * - LE_FAULT on failure
1507  */
1508 //--------------------------------------------------------------------------------------------------
1510 (
1511  uint16_t attempts
1512  ///< [IN] the MANUAL_DIAL_ATTEMPTS value
1513 );
1514 
1515 //--------------------------------------------------------------------------------------------------
1516 /**
1517  * Set tthe AUTO_DIAL_ATTEMPTS value. If a dial attempt under automatic emergency call initiation
1518  * failed, it should be repeated maximally ECALL_AUTO_DIAL_ATTEMPTS-1 times within the maximal time
1519  * limit of ECALL_DIAL_DURATION. The default value is 10.
1520  * Redial attempts stop once the call has been cleared down correctly, or if counter/timer reached
1521  * their limits.
1522  *
1523  * @return
1524  * - LE_OK on success
1525  * - LE_FAULT on failure
1526  */
1527 //--------------------------------------------------------------------------------------------------
1529 (
1530  uint16_t attempts
1531  ///< [IN] the AUTO_DIAL_ATTEMPTS value
1532 );
1533 
1534 //--------------------------------------------------------------------------------------------------
1535 /**
1536  * Set the ECALL_DIAL_DURATION time. It's the maximum time the IVS have to connect the emergency
1537  * call to the PSAP, including all redial attempts.
1538  * If the call is not connected within this time (or ManualDialAttempts/AutoDialAttempts dial
1539  * attempts), it will stop.
1540  *
1541  * @return
1542  * - LE_OK on success
1543  * - LE_FAULT on failure
1544  */
1545 //--------------------------------------------------------------------------------------------------
1547 (
1548  uint16_t duration
1549  ///< [IN] the ECALL_DIAL_DURATION time value (in seconds)
1550 );
1551 
1552 //--------------------------------------------------------------------------------------------------
1553 /**
1554  * Get the MANUAL_DIAL_ATTEMPTS value.
1555  *
1556  * @return
1557  * - LE_OK on success
1558  * - LE_FAULT on failure
1559  */
1560 //--------------------------------------------------------------------------------------------------
1562 (
1563  uint16_t* attemptsPtr
1564  ///< [OUT] the MANUAL_DIAL_ATTEMPTS value
1565 );
1566 
1567 //--------------------------------------------------------------------------------------------------
1568 /**
1569  * Get the AUTO_DIAL_ATTEMPTS value.
1570  *
1571  * @return
1572  * - LE_OK on success
1573  * - LE_FAULT on failure
1574  */
1575 //--------------------------------------------------------------------------------------------------
1577 (
1578  uint16_t* attemptsPtr
1579  ///< [OUT] the AUTO_DIAL_ATTEMPTS value
1580 );
1581 
1582 //--------------------------------------------------------------------------------------------------
1583 /**
1584  * Get the ECALL_DIAL_DURATION time.
1585  *
1586  * @return
1587  * - LE_OK on success
1588  * - LE_FAULT on failure
1589  */
1590 //--------------------------------------------------------------------------------------------------
1592 (
1593  uint16_t* durationPtr
1594  ///< [OUT] the ECALL_DIAL_DURATION time value (in seconds)
1595 );
1596 
1597 //--------------------------------------------------------------------------------------------------
1598 /**
1599  * Set the ERA-GLONASS crash severity parameter.
1600  *
1601  * @return
1602  * - LE_OK on success
1603  * - LE_DUPLICATE an MSD has been already imported
1604  * - LE_BAD_PARAMETER bad eCall reference
1605  */
1606 //--------------------------------------------------------------------------------------------------
1608 (
1609  le_ecall_CallRef_t ecallRef,
1610  ///< [IN] eCall reference
1611  uint32_t crashSeverity
1612  ///< [IN] the ERA-GLONASS crash severity parameter
1613 );
1614 
1615 //--------------------------------------------------------------------------------------------------
1616 /**
1617  * Reset the ERA-GLONASS crash severity parameter. Therefore that optional parameter is not included
1618  * in the MSD message.
1619  *
1620  * @return
1621  * - LE_OK on success
1622  * - LE_DUPLICATE an MSD has been already imported
1623  * - LE_BAD_PARAMETER bad eCall reference
1624  */
1625 //--------------------------------------------------------------------------------------------------
1627 (
1628  le_ecall_CallRef_t ecallRef
1629  ///< [IN] eCall reference
1630 );
1631 
1632 //--------------------------------------------------------------------------------------------------
1633 /**
1634  * Set the ERA-GLONASS diagnostic result using a bit mask.
1635  *
1636  * @return
1637  * - LE_OK on success
1638  * - LE_DUPLICATE an MSD has been already imported
1639  * - LE_BAD_PARAMETER bad eCall reference
1640  */
1641 //--------------------------------------------------------------------------------------------------
1643 (
1644  le_ecall_CallRef_t ecallRef,
1645  ///< [IN] eCall reference
1646  le_ecall_DiagnosticResultBitMask_t diagnosticResultMask
1647  ///< [IN] ERA-GLONASS diagnostic result bit mask.
1648 );
1649 
1650 //--------------------------------------------------------------------------------------------------
1651 /**
1652  * Reset the ERA-GLONASS diagnostic result bit mask. Optional parameter is not
1653  * included in the MSD message.
1654  *
1655  * @return
1656  * - LE_OK on success
1657  * - LE_DUPLICATE an MSD has been already imported
1658  * - LE_BAD_PARAMETER bad eCall reference
1659  */
1660 //--------------------------------------------------------------------------------------------------
1662 (
1663  le_ecall_CallRef_t ecallRef
1664  ///< [IN] eCall reference
1665 );
1666 
1667 //--------------------------------------------------------------------------------------------------
1668 /**
1669  * Set the ERA-GLONASS crash type bit mask
1670  *
1671  * @return
1672  * - LE_OK on success
1673  * - LE_DUPLICATE an MSD has been already imported
1674  * - LE_BAD_PARAMETER bad eCall reference
1675  */
1676 //--------------------------------------------------------------------------------------------------
1678 (
1679  le_ecall_CallRef_t ecallRef,
1680  ///< [IN] eCall reference
1681  le_ecall_CrashInfoBitMask_t crashInfoMask
1682  ///< [IN] ERA-GLONASS crash type bit mask.
1683 );
1684 
1685 //--------------------------------------------------------------------------------------------------
1686 /**
1687  * Reset the ERA-GLONASS crash type bit mask. Optional parameter is not included
1688  * in the MSD message.
1689  *
1690  * @return
1691  * - LE_OK on success
1692  * - LE_DUPLICATE an MSD has been already imported
1693  * - LE_BAD_PARAMETER bad eCall reference
1694  */
1695 //--------------------------------------------------------------------------------------------------
1697 (
1698  le_ecall_CallRef_t ecallRef
1699  ///< [IN] eCall reference
1700 );
1701 
1702 //--------------------------------------------------------------------------------------------------
1703 /**
1704  * Called to get the termination reason.
1705  *
1706  * @return The termination reason.
1707  *
1708  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
1709  * function will not return.
1710  */
1711 //--------------------------------------------------------------------------------------------------
1713 (
1714  le_ecall_CallRef_t ecallRef
1715  ///< [IN] eCall reference.
1716 );
1717 
1718 //--------------------------------------------------------------------------------------------------
1719 /**
1720  * Called to get the platform specific termination code.
1721  *
1722  * @return The platform specific termination code.
1723  *
1724  * @note If the caller is passing a bad pointer into this function, it is a fatal error, the
1725  * function will not return.
1726  */
1727 //--------------------------------------------------------------------------------------------------
1729 (
1730  le_ecall_CallRef_t ecallRef
1731  ///< [IN] eCall reference.
1732 );
1733 
1734 #endif // LE_ECALL_INTERFACE_H_INCLUDE_GUARD
End of the redial period.
Definition: le_ecall_interface.h:586
le_ecall_OpMode_t
Definition: le_ecall_interface.h:514
Motorcycles (Class L3e)
Definition: le_ecall_interface.h:644
AL-ACK clear-down received.
Definition: le_ecall_interface.h:573
Present Left collision indicator.
Definition: le_ecall_interface.h:740
int32_t le_ecall_GetPlatformSpecificTerminationCode(le_ecall_CallRef_t ecallRef)
le_result_t le_ecall_SetMsdVersion(uint32_t msdVersion)
le_result_t le_ecall_StartTest(le_ecall_CallRef_t ecallRef)
le_result_t le_ecall_SetMsdPositionN2(le_ecall_CallRef_t ecallRef, int32_t latitudeDeltaN2, int32_t longitudeDeltaN2)
Persistent eCall only mode.
Definition: le_ecall_interface.h:521
Timeout for Timer T5 (see CEN-EN 16062, annex A)
Definition: le_ecall_interface.h:592
Motorcycles (Class L1e)
Definition: le_ecall_interface.h:640
Present Battery failure.
Definition: le_ecall_interface.h:700
Definition: le_ecall_interface.h:580
le_result_t le_ecall_ForceOnlyMode(void)
Present Right speaker failure.
Definition: le_ecall_interface.h:688
Front collision indicator.
Definition: le_ecall_interface.h:739
le_result_t le_ecall_SendMsd(le_ecall_CallRef_t ecallRef)
le_result_t le_ecall_ResetMsdEraGlonassCrashSeverity(le_ecall_CallRef_t ecallRef)
le_result_t le_ecall_SetEraGlonassDialDuration(uint16_t duration)
le_result_t le_ecall_GetMsdVersion(uint32_t *msdVersionPtr)
Present Comm module interface failure.
Definition: le_ecall_interface.h:708
Present Other critical failures.
Definition: le_ecall_interface.h:722
Diesel propulsion.
Definition: le_ecall_interface.h:666
le_result_t le_ecall_SetMsdEraGlonassDiagnosticResult(le_ecall_CallRef_t ecallRef, le_ecall_DiagnosticResultBitMask_t diagnosticResultMask)
MSD transmission has failed.
Definition: le_ecall_interface.h:569
Definition: le_ecall_interface.h:518
ERA GLONASS standard.
Definition: le_ecall_interface.h:536
Unknown state.
Definition: le_ecall_interface.h:549
Present Battery voltage low failure.
Definition: le_ecall_interface.h:702
le_result_t
Definition: le_basics.h:35
Motorcycles (Class L5e)
Definition: le_ecall_interface.h:648
le_result_t le_ecall_SetMsdEraGlonassCrashSeverity(le_ecall_CallRef_t ecallRef, uint32_t crashSeverity)
le_ecall_MsdVehicleType_t
Definition: le_ecall_interface.h:626
le_result_t le_ecall_ForcePersistentOnlyMode(void)
Motorcycles (Class L6e)
Definition: le_ecall_interface.h:650
Front or side collision indicator.
Definition: le_ecall_interface.h:751
le_result_t le_ecall_SetMsdTxMode(le_ecall_MsdTxMode_t mode)
void le_ecall_ConnectService(void)
Timeout for Timer T10 (see CEN-EN 16062, annex A)
Definition: le_ecall_interface.h:600
Firmware image corruption failure status.
Definition: le_ecall_interface.h:707
le_mcc_TerminationReason_t
Definition: le_mcc_interface.h:251
Present Side collision indicator.
Definition: le_ecall_interface.h:748
Present Mic connection failure.
Definition: le_ecall_interface.h:684
Right speaker failure status.
Definition: le_ecall_interface.h:689
Present Right collision indicator.
Definition: le_ecall_interface.h:742
Other critical failures status.
Definition: le_ecall_interface.h:723
Crash profile memory overflow status.
Definition: le_ecall_interface.h:721
le_result_t le_ecall_GetMsdTxMode(le_ecall_MsdTxMode_t *modePtr)
LL-NACK received.
Definition: le_ecall_interface.h:563
le_result_t le_ecall_GetVehicleType(le_ecall_MsdVehicleType_t *vehicleTypePtr)
Present Crash profile memory overflow.
Definition: le_ecall_interface.h:720
Present Front or side collision indicator.
Definition: le_ecall_interface.h:750
le_result_t le_ecall_ResetMsdEraGlonassCrashInfo(le_ecall_CallRef_t ecallRef)
Left speaker failure status.
Definition: le_ecall_interface.h:691
le_result_t le_ecall_SetVIN(const char *vin)
Rollover indicator.
Definition: le_ecall_interface.h:747
Present Other not critical failures.
Definition: le_ecall_interface.h:724
Ignition line failure status.
Definition: le_ecall_interface.h:695
Pull mode (modem/host waits for MSD request from PSAP to send MSD).
Definition: le_ecall_interface.h:613
Side collision indicator.
Definition: le_ecall_interface.h:749
struct le_ecall_StateChangeHandler * le_ecall_StateChangeHandlerRef_t
Definition: le_ecall_interface.h:763
le_ecall_CrashInfoBitMask_t
Definition: le_ecall_interface.h:736
le_result_t le_ecall_GetConfiguredOperationMode(le_ecall_OpMode_t *opModePtr)
GNSS antenna failure status.
Definition: le_ecall_interface.h:715
le_result_t le_ecall_SetNadDeregistrationTime(uint16_t deregTime)
Present GNSS receiver failure.
Definition: le_ecall_interface.h:710
void le_ecall_SetServerDisconnectHandler(le_ecall_DisconnectHandler_t disconnectHandler, void *contextPtr)
Normal mode.
Definition: le_ecall_interface.h:516
RAIM problem status.
Definition: le_ecall_interface.h:713
void le_ecall_DisconnectService(void)
PAN-EUROPEAN standard.
Definition: le_ecall_interface.h:534
Push mode (modem/host sends MSD to PSAP right after eCall is connected).
Definition: le_ecall_interface.h:615
le_result_t le_ecall_SetEraGlonassAutoDialAttempts(uint16_t attempts)
Other types of damage indicator.
Definition: le_ecall_interface.h:753
UIM failure status.
Definition: le_ecall_interface.h:697
Battery failure status.
Definition: le_ecall_interface.h:701
le_result_t le_ecall_SetEraGlonassManualDialAttempts(uint16_t attempts)
Timeout for Timer T6 (see CEN-EN 16062, annex A)
Definition: le_ecall_interface.h:594
Speaker failure status.
Definition: le_ecall_interface.h:693
Liquid propane gas propulsion.
Definition: le_ecall_interface.h:668
PSAP start indication received.
Definition: le_ecall_interface.h:559
Motorcycles (Class L4e)
Definition: le_ecall_interface.h:646
Light commercial vehicles (Class N1)
Definition: le_ecall_interface.h:634
Gasoline propulsion)
Definition: le_ecall_interface.h:665
le_mcc_TerminationReason_t le_ecall_GetTerminationReason(le_ecall_CallRef_t ecallRef)
void le_ecall_RemoveStateChangeHandler(le_ecall_StateChangeHandlerRef_t handlerRef)
le_ecall_DiagnosticResultBitMask_t
Definition: le_ecall_interface.h:682
Present RAIM problem.
Definition: le_ecall_interface.h:712
Hydrogen propulsion.
Definition: le_ecall_interface.h:670
Present Front collision indicator.
Definition: le_ecall_interface.h:738
Other not critical failures status.
Definition: le_ecall_interface.h:725
le_result_t le_ecall_SetMsdPassengersCount(le_ecall_CallRef_t ecallRef, uint32_t paxCount)
Timeout for Timer T3 (see CEN-EN 16062, annex A)
Definition: le_ecall_interface.h:590
Present Other types of damage indicator.
Definition: le_ecall_interface.h:752
le_ecall_State_t le_ecall_GetState(le_ecall_CallRef_t ecallRef)
LL-ACK received.
Definition: le_ecall_interface.h:565
Waiting for PSAP start indication.
Definition: le_ecall_interface.h:557
le_result_t le_ecall_End(le_ecall_CallRef_t ecallRef)
struct le_ecall_Call * le_ecall_CallRef_t
Definition: le_ecall_interface.h:506
le_result_t le_ecall_StartManual(le_ecall_CallRef_t ecallRef)
le_result_t le_ecall_ResetMsdEraGlonassDiagnosticResult(le_ecall_CallRef_t ecallRef)
MSD transmission is complete.
Definition: le_ecall_interface.h:567
le_result_t le_ecall_GetSystemStandard(le_ecall_SystemStandard_t *systemStandardPtr)
Timeout for Timer T7 (see CEN-EN 16062, annex A)
Definition: le_ecall_interface.h:596
Comm module failure status.
Definition: le_ecall_interface.h:717
le_ecall_SystemStandard_t
Definition: le_ecall_interface.h:532
le_result_t le_ecall_SetMsdEraGlonassCrashInfo(le_ecall_CallRef_t ecallRef, le_ecall_CrashInfoBitMask_t crashInfoMask)
Events memory overflow status.
Definition: le_ecall_interface.h:719
Timeout for Timer T2 (see CEN-EN 16062, annex A)
Definition: le_ecall_interface.h:588
Present GNSS antenna failure.
Definition: le_ecall_interface.h:714
void(* le_ecall_DisconnectHandler_t)(void *)
Definition: le_ecall_interface.h:402
Heavy duty vehicles (Class N2)
Definition: le_ecall_interface.h:636
le_result_t le_ecall_SetMsdPosition(le_ecall_CallRef_t ecallRef, bool isTrusted, int32_t latitude, int32_t longitude, int32_t direction)
le_result_t le_ecall_SetVehicleType(le_ecall_MsdVehicleType_t vehicleType)
Present Rollover indicator.
Definition: le_ecall_interface.h:746
le_ecall_CallRef_t le_ecall_Create(void)
Status indicator failure status.
Definition: le_ecall_interface.h:699
Present UIM failure.
Definition: le_ecall_interface.h:696
Present indicator.
Definition: le_ecall_interface.h:744
MSD transmission is started.
Definition: le_ecall_interface.h:561
le_result_t le_ecall_ImportMsd(le_ecall_CallRef_t ecallRef, const uint8_t *msdPtr, size_t msdSize)
eCall session started.
Definition: le_ecall_interface.h:551
Heavy duty vehicles (Class N3)
Definition: le_ecall_interface.h:638
Present Left speaker failure.
Definition: le_ecall_interface.h:690
Rear impact indicator.
Definition: le_ecall_interface.h:745
Present Mic failure.
Definition: le_ecall_interface.h:686
le_result_t le_ecall_UseUSimNumbers(void)
le_result_t le_ecall_SetPsapNumber(const char *psap)
Buses and coaches (Class M3)
Definition: le_ecall_interface.h:632
le_result_t le_ecall_GetEraGlonassManualDialAttempts(uint16_t *attemptsPtr)
Present Status indicator failure.
Definition: le_ecall_interface.h:698
Mic failure status.
Definition: le_ecall_interface.h:687
le_result_t le_ecall_GetNadDeregistrationTime(uint16_t *deregTimePtr)
Right collision indicator.
Definition: le_ecall_interface.h:743
le_result_t le_ecall_GetEraGlonassAutoDialAttempts(uint16_t *attemptsPtr)
Emergency call is established.
Definition: le_ecall_interface.h:553
Unsuccessful eCall session.
Definition: le_ecall_interface.h:584
le_result_t le_ecall_ExitOnlyMode(void)
le_result_t le_ecall_SetMsdPositionN1(le_ecall_CallRef_t ecallRef, int32_t latitudeDeltaN1, int32_t longitudeDeltaN1)
Buses and coaches (Class M2)
Definition: le_ecall_interface.h:630
le_result_t le_ecall_GetPropulsionType(le_ecall_PropulsionTypeBitMask_t *propulsionTypePtr)
void(* le_ecall_StateChangeHandlerFunc_t)(le_ecall_CallRef_t ecallRef, le_ecall_State_t state, void *contextPtr)
Definition: le_ecall_interface.h:773
Present Crash sensor failure.
Definition: le_ecall_interface.h:704
Motorcycles (Class L7e)
Definition: le_ecall_interface.h:652
le_result_t le_ecall_GetEraGlonassDialDuration(uint16_t *durationPtr)
Present Speaker failure.
Definition: le_ecall_interface.h:692
AL-ACK received.
Definition: le_ecall_interface.h:571
Battery voltage low failure status.
Definition: le_ecall_interface.h:703
le_ecall_State_t
Definition: le_ecall_interface.h:547
le_ecall_MsdTxMode_t
Definition: le_ecall_interface.h:611
le_result_t le_ecall_SetIntervalBetweenDialAttempts(uint16_t pause)
Emergency call is disconnected.
Definition: le_ecall_interface.h:555
Definition: le_ecall_interface.h:575
Present Events memory overflow.
Definition: le_ecall_interface.h:718
Compressed natural gas propulsion.
Definition: le_ecall_interface.h:667
le_result_t le_ecall_StartAutomatic(le_ecall_CallRef_t ecallRef)
Comm module interface failure status.
Definition: le_ecall_interface.h:709
Electric propulsion.
Definition: le_ecall_interface.h:669
GNSS receiver failure status.
Definition: le_ecall_interface.h:711
eCall session has lost synchronization and starts over.
Definition: le_ecall_interface.h:578
Present Comm module failure.
Definition: le_ecall_interface.h:716
Other type of propulsions.
Definition: le_ecall_interface.h:671
Passenger vehicle (Class M1)
Definition: le_ecall_interface.h:628
Timeout for Timer T9 (see CEN-EN 16062, annex A)
Definition: le_ecall_interface.h:598
Mic connection failure status.
Definition: le_ecall_interface.h:685
le_result_t le_ecall_TryConnectService(void)
le_ecall_StateChangeHandlerRef_t le_ecall_AddStateChangeHandler(le_ecall_StateChangeHandlerFunc_t handlerPtr, void *contextPtr)
le_result_t le_ecall_ExportMsd(le_ecall_CallRef_t ecallRef, uint8_t *msdPtr, size_t *msdSizePtr)
Left collision indicator.
Definition: le_ecall_interface.h:741
le_result_t le_ecall_GetPsapNumber(char *psap, size_t psapSize)
Motorcycles (Class L2e)
Definition: le_ecall_interface.h:642
le_result_t le_ecall_GetVIN(char *vin, size_t vinSize)
Present Firmware image corruption failure.
Definition: le_ecall_interface.h:706
void le_ecall_Delete(le_ecall_CallRef_t ecallRef)
le_result_t le_ecall_SetSystemStandard(le_ecall_SystemStandard_t systemStandard)
Present Ignition line failure.
Definition: le_ecall_interface.h:694
le_result_t le_ecall_SetPropulsionType(le_ecall_PropulsionTypeBitMask_t propulsionType)
le_ecall_PropulsionTypeBitMask_t
Definition: le_ecall_interface.h:663
le_result_t le_ecall_GetIntervalBetweenDialAttempts(uint16_t *pausePtr)
Crash sensor failure status.
Definition: le_ecall_interface.h:705