< [IN] Communication channel.
[OUT] The end cause enumeration.
[IN] The call reference.
[IN] SIM slot ID.
[IN] Manifest for activation verification.
[OUT] The active bank.
[IN] Installation session reference.
[IN] Package path.
[IN] Manifest for pre-check.
[OUT] Installation session reference.
[IN] Download session reference.
[OUT] Download session reference.
[IN] OTA package name.
[IN] Cooling device sample reference
[IN] Trip event sample reference
[IN] The cooling device name
[IN] Thermal zone name
[OUT] The current cooling level associated with
[OUT] The maximum cooling level associated with
[OUT] The cooling device ID associated with the
[IN] Cooling device reference
[IN] Cooling device list reference
[OUT] List size
[IN] Thermal Zone list reference
[OUT] The bound thermal zone ID associated with
[OUT] The bound trip point trip ID associated with
[OUT] The hysteresis associated with the input bound cooling device's trip point object.
[OUT] The threshold associated with the input bound
[OUT] The bound cooling device trip
[OUT] The cooling device ID associated with
[OUT] The thermal zone ID associated with
[OUT] The trip ID associated with the input
[OUT] The hysteresis associated with the input
[OUT] The threshold associated with the input
[OUT] The bound cooling device list size
[OUT] The trip point device list size
[OUT] Thermal zone passive temperature associated with
[OUT] Thermal zone current temperature associated with
[OUT] Thermal zone ID associated with
[IN] Bound cooling device reference
[IN] Thermal zone reference
[IN] Thermal zone list reference
[OUT] List size.
[IN] Rx Message reference.
[OUT] Payload Size in bytes.
[OUT] Message Type.
[OUT] Client ID.
[OUT] Method ID.
[OUT] Instance ID.
[IN] Event ID.
[IN] Cycle Time in milliseconds.
[IN] Event Group ID, valid range: 0x0001 to 0xFFFE.
[IN] If TCP magic cookie is enabled when TCP server is set
[IN] Minor Version.
[IN] Event Group ID.
[IN] Event Type.
[IN] Timeout in milliseconds.
[IN] Tx message reference.
[IN] Method ID.
[OUT] Minor Version.
[OUT] Service State.
[IN] Service Reference.
[IN] Network interface name.
[IN] Instance ID.
[OUT] SOME/IP Client ID.
[IN] Ending point of the range.
[IN] Ending point of the filter.
[IN] Timeout value message sent.
[OUT] Preferred storage type.
[IN] Preferred storage type.
[IN] SMS center address.
[OUT] Pointer to the stored phone ID.
[IN] Text message.
[IN] Destination number.
[IN] Message reference.
[IN] Message list reference.
[IN] Profile index.
[IN] Confirmation code.
[IN] User consent reason.
[IN] SM-DP+ address.
[IN] Nick name.
[IN] Enabled or not; true if enabling, false if disabling.
[IN] Whether user consent is
[OUT] Slot count.
[IN] FPLMN list reference.
[IN] SIM identifier.
[IN] Mobile Network Code.
[OUT] - True – Emergency call subscription (ECS) is selected.
[IN] The SIM identifier.
[IN] The power state.
[IN] The card manufacturer.
[IN] The channel ID to be closed.
[OUT] Channel as output.
[OUT] Enable flag as output.
[IN] Enable flag
[OUT] Number of PUK retries remaining.
[IN] New PIN1/PIN2.
[IN] PIN1/PIN2.
[IN] Slot ID.
[OUT] The maximum number of SIMs that can be active simultaneously.
[IN] User agent string to be sent with SIP message.
[OUT] True if service is enabled, false if service is disabled.
[IN] True if enabling service, false if disabling service.
[OUT] PDP error code.
[OUT] IMS service status.
[OUT] CS capabilitiy of LTE network.
[OUT] RAT service status.
[OUT] Base Station Identity Code
[IN] Neighbor cell information reference
[IN] Neighbor cell information reference.
[IN] Neighboring cell information reference.
[IN] Cell information reference.
[IN] Neighbor cells reference.
[IN] PCI network scan information reference.
[IN] The network scan operator reference.
[IN] The scan information list reference.
[IN] The network scan information list reference.
[OUT] Signal-to-Noise Ratio in units of 0.1 dB.
[OUT] EVDO Ec/Io in dB.
[OUT] Signal-to-noise ratio in units of 0.1 dB.
[OUT] Receive signal channel power in dBm.
[OUT] Bit error rate, valid from 0 to 7.
[IN] The signal metrics reference.
[OUT] RAT bitmask.
[IN] The preferred operators list reference.
[IN] The acknowledgement type.
[IN] Virtual Machine list reference.
[IN] Virtual Machine name of the state to be changed.
[IN] State to be set.
[IN] Reference to the wakeup source to be released.
[IN] Reference to the wakeup source to be acquired.
[IN] Context-specific wakeup source tag.
[IN] GSB reference.
[IN] Reference of a GSB list.
[IN] Bandwidth (in Mbps).
[IN] Username.
[IN] Profile ID.
[IN] Authentication method.
[IN] Tunnel entry reference.
[IN] Reference of a tunnel entry list.
[IN] Local tunnel ID.
[IN] Peer session ID.
[IN] Peer UDP port, if IP encapsulation is used.
[IN] Tunnel reference.
[IN] Interface name.
[IN] Optional MTU size in bytes; default is 1422.
[IN] Profile ID for VLAN association.
[OUT] Phone ID for VLAN association.
[OUT] Is accelerated or not.
[IN] VLAN entry reference.
[IN] Reference of a VLAN entry list.
[OUT] Priority.
[IN] VLAN interface reference.
[IN] Reference of a VLAN interface list.
[IN] Interface type.
[IN] VLAN ID.
[IN] VLAN reference.
[IN] Priority.
[IN] Is acceleration allowed.
[OUT] IP protocol number.
[IN] The reference of a destination entry list.
[IN] The profile ID.
[IN] IP protocol number.
[OUT] DNS addresses structure.
[IN] The interface from which to get the DNS addresses.
[IN] The interface from which to get the default gateway addresses.
[IN] Add or delete.
[IN] OTA operation status.
[OUT] The data state.
[IN] The data reference.
[OUT] The data object ID from the configuration JSON.
[IN] The data name to use.
[IN] The data ID to use.
[IN] The taf_dcs profile reference.
[IN] Reference to a Positioning Control service activation request.
[OUT] UTC day of the month; range is 1 to 31.
[IN] Resolution.
[OUT] The vertical speed's accuracy in m/sec.
[OUT] The horizontal accuracy in m/sec.
[OUT] Vertical accuracy in meters by default.
[IN] Acquisition Rate in milliseconds.
[OUT] UTC Milliseconds of the second; range is 0 to 999.
[OUT] Direction's accuracy estimation in degrees.
[OUT] Vertical speed accuracy in m/sec.
[OUT] UTC Days into the month; range is 1 to 31.
[OUT] Horizontal accuracy in meters by default.
[OUT] Gptp time stamp uncertainty in nanoseconds.
[IN] Validity mask for dead reckoning parameters.
[OUT] Specify XTRA assistant data's current status,
[IN] Specify the Engine type for which Nmea sentences
[OUT] The GNSS capability information.
[OUT] Minimum GPS week used by modem GNSS engine.
[IN] The minimum GPS week to be used by modem GNSS engine.
[OUT] Altitude Mean Sea Level in meters.
[OUT] Engine type bit mask taf_locGnss_ReportStatus.
[OUT] Elapsed real time uncertainty in nano-second.
[OUT] North standard deviation.
[OUT] Vertical reliability. LocationReliability
[OUT] Location engine type. LocationAggregationType
[OUT] Validity ex bit mask. LocationInfoExValidity
[OUT] Technology mask taf_locGnss_LocationTechnologyType.
[OUT] SBAS bit mask taf_locGnss_SbasBitMask.
[OUT] SV data reference.
[OUT] Up velocity in meter/sec.
[OUT] VRP based altitude above the WGS 84
[OUT] Body data reference.
[OUT] Confidence percentage.
[OUT] Conformity index. When robust location is enabled, this field
[IN] Engine type.
[IN] The structure reference for lever arm parameters.
[OUT] Horizontal confidence level. It is defined with 39% confidence level.
[OUT] MagneticDeviation in degrees. It is the difference between
[IN] Bitmask of secondary band constellations to disable. SBConstellation
[OUT] Bitmask to get enabled secondary band constellations. SBConstellation
[OUT] Minor version number.
[IN] Enable(1) or disable for 911 enable/disable.
[IN] Engine state.
[OUT] Supported NMEA sentence types.
[IN] The structure reference which passes dead reckoning parameters.
[OUT] Bitmask for enabled NMEA sentence types.
[IN] Bitmask for enabled NMEA sentence types.
[OUT] Minimum elevation in degrees; range is 0 to 90.
[IN] Start Mode.
[IN] Minimum elevation in degrees.
[OUT] Supported GNSS constellations.
[IN] Acquisition rate in milliseconds for GNSS.
[OUT] Time in to the current week in ms.
[OUT] UTC leap seconds value to be applied in milliseconds.
[OUT] DOP corresponding to the dopType
[IN] DOP resolution.
[OUT] Epoch time in milli seconds since Jan 1, 1970.
[OUT] Time accuracy in nanoseconds. For PVT report from SPE
[OUT] TTFF in milliseconds.
[OUT] Acquisition rate in milliseconds for GNSS.
[OUT] Number of satellites in view used for
[OUT] Bitmask of constellation that are blacklisted.
[IN] Bitmask of constellation that needs to be blacklisted.
[OUT] UTC milliseconds of the second; range is 0 to 999.
[OUT] UTC days of the month; range is 1 to 31.
[OUT] UTC leap seconds in seconds.
[OUT] Vertical speed's accuracy estimation in dm/sec.
[OUT] Horizontal accuracy estimation in dm/sec.
[OUT] Vertical uncertainty in dm. Uncertainty is defined with 68% confidence level.
[OUT] Direction accuracy estimation in degrees with 1 decimal place.
[OUT] Horizontal accuracy in cm. Uncertainty is defined with 68%
[IN] Position sample reference.
[OUT] Position fix state.
[IN] Session reference.
[IN] Cryptographic operation purpose.
[OUT] Session reference.
[IN] Milliseconds since January 1, 1970.
[IN] Seconds interval between allowed operations.
[IN] Uses per boot.
[OUT] Key usage.
[IN] Key reference.
[OUT] Key reference.
[OUT] Block count.
[OUT] Device ID.
[OUT] Bad block size.
[IN] MTD node list reference
[IN] MTD device list reference
[OUT] UBI volume size.
[OUT]
[IN] UBI device Info reference.
[OUT] Bad Block count.
[OUT] Erase count.
[OUT] UBI device ID
[IN] UBI device list reference
[OUT] Free memory in kB.
[OUT] cpuUsage
[OUT] CPU Total Usage.
[IN] GPIO pin number.
[IN] Set to True to lock this GPIO pin from being used by other clients.
[IN] Storage reference.
[OUT] Error status.
[IN] The number of bytes set to write to UBI volume.
[OUT] Volume size.
[IN] The UBI volume reference.
[OUT] The UBI volume reference.
[IN] Logical block index.
[OUT] Page size.
[IN] The MTD partition reference.
[OUT] The MTD partition reference.
[OUT]The elapsed time of the HLAP timer in unit of seconds.
[OUT] The eCall minimum network registration time (in minutes).
[IN] The eCall minimum network registration time (in minutes).
[OUT] The eCall clear down fallback time (in minutes).
[IN] The eCall clear down fallback time (in minutes).
[OUT] The eCall deregistration time (in minutes).
[IN] The eCall deregistration time (in minutes).
[IN] Public Safely Answering Point number
[IN] SIP Accept header. The maximum length
[IN] DeltaVY
[IN] Rollover detected
[IN] Location of impact
[IN] eCall reference.
[IN] Passenger count.
[IN] The direction of the vehicle from magnetic north (0
[OUT] MSD transmission mode as output.
[IN] MSD transmission mode.
[OUT] Vehicle propulsion storage type as output.
[IN] Vehicle propulsion storage type.
[IN] Vehicle identification number.
[OUT] Vehicle type as output.
[IN] Vehicle type.
[OUT] MSD version as output.
[OUT] Operating mode.
[IN] Phone ID.
[IN] Emergency call reference.
[OUT] Transfer exit request parameter record length.
[OUT] Transfer data request parameter record length.
[OUT] Block sequence counter.
[IN] Specifies the size of the compressed file in bytes.
[IN] Specifies the byte position for downloading file resume.
[OUT] Size of the compressed file.
[OUT] Size of the uncompressed file.
[OUT] Data format ID.
[OUT] Security access payload length.
[OUT] Current session control type.
[IN] Routine identifier.
[IN] Error code type.
[IN] Data identifier.
[IN] Service reference.
[IN] data identifier.
[IN] The password.
[IN] The PDP type.
[OUT] The APN type.
[IN] The APN name.
[OUT] The phone ID.
[IN] The profile index.
[OUT] The profile index.
[INOUT]
[OUT] The uplink data bearer technology.
[OUT] The connection state.
[OUT] The roaming type. Valid only if roaming is on.
[IN] The profile reference.
[IN] Reference of the created CAN frame to delete.
[IN] Reference of the created CAN interface to delete.
[IN] Reference of the created CAN frame to send.
[IN] CAN frame type.
[IN] frame ID.
[IN] Reference of the created CAN interface.
[IN] Frame ID.
[IN] CAN interface type.
[OUT] Encoding format.
[IN] Encoding format.
[OUT] Channel number.
[IN] Channel number.
[OUT] Sampling rate.
[IN] Sampling rate.
[IN] The time slot number.
[IN] The channel mode.
[OUT] Check for NoiseSuppressor flag.
[OUT] Check for EchoCanceller flag.
[OUT] Gain parameter.
[IN] Set gain parameter.
[IN] File descriptor.
[IN] Pause between tones.
[IN] Slot value.
[IN] Slot value
[IN] Connector reference.
[IN] Audio stream reference.
[OUT] App information.
[IN] The reference to the app list.
[IN] App name.
[OUT] The max watchdog timeout set for this process
[OUT] The watchdog timeout set for this process
[IN] The number of milliseconds until this timer expires
[IN] True to set system Good even if someone holds a probation lock
[IN] Get the system that's older than this system.
[IN] Open file descriptor from which the update can be read.
[IN] Name of the module to unload.
[IN] Name of the module to load.
[IN] Was the restart manually triggered e.g. "legato restart"
[IN] Iterator object to release.
[IN] Name of the tree to delete.
[IN] Default value to use if the original can't be read.
[IN] Absolute or relative path to read from.
[IN] Path to the node to delete.
[IN] Value to write.
[IN] Iterator to iterate.
[IN] Iterator object to move.
[IN] Iterator to move.
[IN] Absolute or relative path from the current location.
[IN] Iterator object to close.
[IN] Iterator object to commit.
[IN] Path to the location to create the new iterator.
[IN] Process name.
[IN] Application name.
[IN] Name of the app to stop.
[IN] Name of the app to start.
[IN] PID of the process to unblock.
[IN]
[IN] Permission string, "r", "w", "rw".
[IN] Absolute path to the file to import.
[IN] Flag to debug the process or not.
[IN] Flag to run the process or not.
[IN] Ref to the app.
[IN] Name of the app to get the ref for.
Function for Creating a RPC Communication Channel
Return Code
- LE_OK if successfully,
- otherwise failure
- Returns
- Opaque handle to the Communication Channel.
Function for Registering a Callback Handler function to monitor events on the specific handle
- Returns
-
Function for Deleting a RPC Communicaiton Channel
- Returns
-
Function for Connecting a RPC Communication Channel
- Returns
- LE_OK if successfully,
- LE_IN_PROGRESS if pending on asynchronous connection,
- otherwise failure.
Function for Disconnecting a RPC Communication Channel
- Returns
-
Function for Sending Data over a RPC Communication Channel
- Returns
-
Function for Receiving Data over a RPC Communication Channel
- Returns
-
Get Support Functions Function to retrieve an ID for the specified handle. NOTE: For logging or display purposes only.
- Returns
- Non-zero integer, if successful.
- Negative one (-1), otherwise.
Function to retrieve the Parent Handle. NOTE: For asynchronous connections only.
- Returns
- Parent (Listening) handle, if successfully.
- NULL, otherwise.
Cleanup the data of a sessions
Perform common initialization and open a session
Gets a reference to an app.
- Returns
- Reference to the named app. NULL on error (check logs for errors).
Release the reference to an app, resetting all overrides set for this app using other functions, like SetRun(), SetDevicePerm(), etc.
Sets the run flag for a process in an app.
If there is an error this function will kill the calling client.
Sets the debug flag for a process in an app.
If there is an error this function will kill the calling client.
Imports a file into the app's working directory.
- Returns
- LE_OK if successfully imported the file. LE_DUPLICATE if the path conflicts with items already in the app's working directory. LE_NOT_FOUND if the path does not point to a valid file. LE_BAD_PARAMETER if the path is formatted incorrectly. LE_FAULT if there was some other error.
- Note
- If the caller is passing an invalid reference to the app, it is a fatal error, the function will not return.
Sets a device file's permissions.
- Returns
- LE_OK if successfully set the device's permissions. LE_NOT_FOUND if the path does not point to a valid device. LE_BAD_PARAMETER if the path is formatted incorrectly. LE_FAULT if there was some other error.
- Note
- If the caller is passing an invalid reference to the app, it is a fatal error, the function will not return.
Add handler function for EVENT 'le_appCtrl_TraceAttach'
Event that indicates the process is blocked and can be attached to.
Remove handler function for EVENT 'le_appCtrl_TraceAttach'
Unblocks the traced process. This should normally be done once the tracer has successfully attached to the process.
- Note
- If the caller is passing an invalid reference to the app, it is a fatal error, the function will not return.
Starts an app.
- Returns
- LE_OK if the app is successfully started. LE_DUPLICATE if the app is already running. LE_NOT_FOUND if the app isn't installed. LE_FAULT if there was an error and the app could not be launched.
Stops an app.
- Returns
- LE_OK if successful. LE_NOT_FOUND if the app could not be found.
Gets the state of the specified application. The state of unknown applications is STOPPED.
- Returns
- The state of the specified application.
- Note
- If the application name pointer is null or if its string is empty or of bad format it is a fatal error, the function will not return.
Gets the state of the specified process in an application. This function only works for configured processes that the Supervisor starts directly.
- Returns
- The state of the specified process.
- Note
- If the application or process names pointers are null or if their strings are empty or of bad format it is a fatal error, the function will not return.
Gets the application name of the process with the specified PID.
- Returns
- LE_OK if the application name was successfully found. LE_OVERFLOW if the application name could not fit in the provided buffer. LE_NOT_FOUND if the process is not part of an application. LE_FAULT if there was an error.
Gets the application hash as a hexidecimal string. The application hash is a unique hash of the current version of the application.
- Returns
- LE_OK if the application has was successfully retrieved. LE_OVERFLOW if the application hash could not fit in the provided buffer. LE_NOT_FOUND if the application is not installed. LE_FAULT if there was an error.
- Note
- If the application name pointer is null or if its string is empty or of bad format it is a fatal error, the function will not return.
Create a read transaction and open a new iterator for traversing the config tree.
This action creates a read lock on the given tree, which will start a read-timeout. Once the read timeout expires, all active read iterators on that tree will be expired and their clients will be killed.
- Note
- A tree transaction is global to that tree; a long-held read transaction will block other user's write transactions from being committed.
- Returns
- This will return the newly created iterator reference.
Create a write transaction and open a new iterator for both reading and writing.
This action creates a write transaction. If the app holds the iterator for longer than the configured write transaction timeout, the iterator will cancel the transaction. Other reads will fail to return data, and all writes will be thrown away.
- Note
- A tree transaction is global to that tree; a long-held write transaction will block other user's write transactions from being started. Other trees in the system won't be affected.
- Returns
- This will return a newly created iterator reference.
Closes the write iterator and commits the write transaction. This updates the config tree with all of the writes that occurred within the iterator.
- Note
- This operation will also delete the iterator object.
Closes and frees the given iterator object. If the iterator is a write iterator, the transaction will be canceled. If the iterator is a read iterator, the transaction will be closed. No data is written to the tree
- Note
- This operation will also delete the iterator object.
Changes the location of iterator. The path passed can be an absolute or a relative path from the iterators current location.
The target node does not need to exist. Writing a value to a non-existent node will automatically create that node and any ancestor nodes (parent, parent's parent, etc.) that also don't exist.
Move the iterator to the parent of the current node (moves up the tree).
- Returns
- Return code will be one of the following values:
- LE_OK - Commit was completed successfully.
- LE_NOT_FOUND - Current node is the root node: has no parent.
Moves the iterator to the the first child of the node from the current location.
For read iterators without children, this function will fail. If the iterator is a write iterator, then a new node is automatically created. If this node or newly created children of this node are not written to, then this node will not persist even if the iterator is committed.
- Returns
- Return code will be one of the following values:
- LE_OK - Move was completed successfully.
- LE_NOT_FOUND - The given node has no children.
Jumps the iterator to the next child node of the current node. Assuming the following tree:
baseNode
|
+childA
|
+valueA
|
+valueB
If the iterator is moved to the path, "/baseNode/childA/valueA". After the first GoToNextSibling the iterator will be pointing at valueB. A second call to GoToNextSibling will cause the function to return LE_NOT_FOUND.
- Returns
- Returns one of the following values:
- LE_OK - Commit was completed successfully.
- LE_NOT_FOUND - Iterator has reached the end of the current list of siblings.
Also returned if the the current node has no siblings.
Get path to the node where the iterator is currently pointed.
Assuming the following tree:
baseNode
|
+childA
|
+valueA
|
+valueB
If the iterator was currently pointing at valueA, GetPath would return the following path:
Optionally, a path to another node can be supplied to this function. So, if the iterator is again on valueA and the relative path ".." is supplied then this function will return the the path relative to the node given:
- Returns
- - LE_OK - The write was completed successfully.
- LE_OVERFLOW - The supplied string buffer was not large enough to hold the value.
Get the data type of node where the iterator is currently pointing.
- Returns
- le_cfg_nodeType_t value indicating the stored value.[IN] Path to the target node. Can be an absolute path, or a path relative from the iterator's current position.
Get the name of the node where the iterator is currently pointing.
- Returns
- - LE_OK Read was completed successfully.
- LE_OVERFLOW Supplied string buffer was not large enough to hold the value.
Add handler function for EVENT 'le_cfg_Change'
This event provides information on changes to the given node object, or any of it's children, where a change could be either a read, write, create or delete operation.
Remove handler function for EVENT 'le_cfg_Change'
Deletes the node specified by the path. If the node doesn't exist, nothing happens. All child nodes are also deleted.
If the path is empty, the iterator's current node is deleted.
This function is only valid during a write transaction.[IN] Path to the target node. Can be an absolute path, or a path relative from the iterator's current position.
Check if the given node is empty. A node is also considered empty if it doesn't yet exist. A node is also considered empty if it has no value or is a stem with no children.
If the path is empty, the iterator's current node is queried for emptiness.
Valid for both read and write transactions.
- Returns
- A true if the node is considered empty, false if not.[IN] Path to the target node. Can be an absolute path, or a path relative from the iterator's current position.
Clears out the node's value. If the node doesn't exist it will be created, and have no value.
If the path is empty, the iterator's current node will be cleared. If the node is a stem then all children will be removed from the tree.
Only valid during a write transaction.[IN] Path to the target node. Can be an absolute path, or a path relative from the iterator's current position.
Checks to see if a given node in the config tree exists.
- Returns
- True if the specified node exists in the tree. False if not.[IN] Path to the target node. Can be an absolute path, or a path relative from the iterator's current position.
Reads a string value from the config tree. If the value isn't a string, or if the node is empty or doesn't exist, the default value will be returned.
Valid for both read and write transactions.
If the path is empty, the iterator's current node will be read.
- Returns
- - LE_OK - Read was completed successfully.
- LE_OVERFLOW - Supplied string buffer was not large enough to hold the value.[IN] Default value to use if the original can't be read.
Writes a string value to the config tree. Only valid during a write transaction.
If the path is empty, the iterator's current node will be set.
Read a binary data from the config tree. If the the node has a wrong type, is empty or doesn't exist, the default value will be returned.
Valid for both read and write transactions.
If the path is empty, the iterator's current node will be read.
Responds With:
This function will respond with one of the following values:
- LE_OK - Read was completed successfully.
- LE_FORMAT_ERROR - if data can't be decoded.
- LE_OVERFLOW - Supplied buffer was not large enough to hold the value.Write a binary data to the config tree. Only valid during a write transaction.
If the path is empty, the iterator's current node will be set.
- Note
- Binary data cannot be written to the 'system' tree.
Reads a signed integer value from the config tree.
If the underlying value is not an integer, the default value will be returned instead. The default value is also returned if the node does not exist or if it's empty.
If the value is a floating point value, then it will be rounded and returned as an integer.
Valid for both read and write transactions.
If the path is empty, the iterator's current node will be read.[IN] Default value to use if the original can't be read.
Writes a signed integer value to the config tree. Only valid during a write transaction.
If the path is empty, the iterator's current node will be set.
Reads a 64-bit floating point value from the config tree.
If the value is an integer then the value will be promoted to a float. Otherwise, if the underlying value is not a float or integer, the default value will be returned.
If the path is empty, the iterator's current node will be read.
- Note
- Floating point values will only be stored up to 6 digits of precision.[IN] Default value to use if the original can't be read.
Writes a 64-bit floating point value to the config tree. Only valid during a write transaction.
If the path is empty, the iterator's current node will be set.
- Note
- Floating point values will only be stored up to 6 digits of precision.
Reads a value from the tree as a boolean. If the node is empty or doesn't exist, the default value is returned. Default value is also returned if the node is a different type than expected.
Valid for both read and write transactions.
If the path is empty, the iterator's current node will be read.[IN] Default value to use if the original can't be read.
Writes a boolean value to the config tree. Only valid during a write transaction.
If the path is empty, the iterator's current node will be set.
Deletes the node specified by the path. If the node doesn't exist, nothing happens. All child nodes are also deleted.
Clears the current value of a node. If the node doesn't currently exist then it is created as a new empty node.
Reads a string value from the config tree. If the value isn't a string, or if the node is empty or doesn't exist, the default value will be returned.
- Returns
- - LE_OK - Commit was completed successfully.
- LE_OVERFLOW - Supplied string buffer was not large enough to hold the value.
Writes a string value to the config tree.
Reads a binary data from the config tree. If the node type is different, or if the node is empty or doesn't exist, the default value will be returned.
- Returns
- - LE_OK - Commit was completed successfully.
- LE_FORMAT_ERROR - if data can't be decoded.
- LE_OVERFLOW - Supplied buffer was not large enough to hold the value.
Writes a binary data to the config tree.
Reads a signed integer value from the config tree. If the value is a floating point value, then it will be rounded and returned as an integer. Otherwise If the underlying value is not an integer or a float, the default value will be returned instead.
If the value is empty or the node doesn't exist, the default value is returned instead.
Writes a signed integer value to the config tree.
Reads a 64-bit floating point value from the config tree. If the value is an integer, then it is promoted to a float. Otherwise, if the underlying value is not a float, or an integer the default value will be returned.
If the value is empty or the node doesn't exist, the default value is returned.
- Note
- Floating point values will only be stored up to 6 digits of precision.
Writes a 64-bit floating point value to the config tree.
- Note
- Floating point values will only be stored up to 6 digits of precision.
Reads a value from the tree as a boolean. If the node is empty or doesn't exist, the default value is returned. This is also true if the node is a different type than expected.
If the value is empty or the node doesn't exist, the default value is returned instead.
Writes a boolean value to the config tree.
Read a subset of the configuration tree from the given filePath. The tree then overwrites the node at the given nodePath.
This function will import a sub-tree as part of the iterator's current transaction. This allows you to create an iterator on a given node. Import a sub-tree, and then examine the contents of the import before deciding to commit the new data.
- Returns
- This function will return one of the following values:
- LE_OK - The commit was completed successfuly.
- LE_FAULT - An I/O error occured while reading the data.
- LE_FORMAT_ERROR - The configuration data being imported appears corrupted. [IN] Where in the tree should this import happen? Leave as an empty string to use the iterator's current node.
Take a node given from nodePath and stream it and it's children to the file given by filePath.
This funciton uses the iterator's read transaction, and takes a snapshot of the current state of the tree. The data write happens immediately.
- Returns
- This function will return one of the following values:
- LE_OK - The commit was completed successfuly.
- LE_FAULT - An I/O error occured while writing the data. [IN] Where in the tree should this export happen? Leave as an empty string to use the iterator's current node.
Delete a tree from the system, both from the filesystem and from memory.
Create a new iterator object for iterating over the list of trees currently managed by the config tree daemon.
Release the iterator and free it's memory back to the system.
Read the name of the tree currently pointed at by the iterator.
- Returns
- LE_OK if there is enough room to copy the name into the supplied buffer. LE_OVERFLOW if not. LE_NOT_FOUND is returned if the list is empty or if the iterator hasn't been moved onto the first item yet.
Move onto the next tree in the list. If there are no more trees this function returns false, otherwise true is returned.
- Returns
- LE_OK if there are more trees to iterate through. LE_NOT_FOUND if not.
Stops the Legato framework.
- Returns
- LE_OK if successful. LE_DUPLICATE if the framework is in the process of shutting down (perhaps someone else has already requested the framework be stopped or restarted).
Restarts the Legato framework.
- Returns
- LE_OK if the request was accepted and the restart procedure has begun. LE_DUPLICATE if the framework is already in the process of shutting down (perhaps someone else has already requested the framework be stopped or restarted).
Reports if the Legato framework is stopping.
- Returns
- true if the framework is stopping or rebooting false otherwise
Checks whether legato framework is Read-Only or not.
- Returns
- true if the framework is Read-Only false otherwise
Mark the next reboot as expected. Should be called by short lived app that shutdown platform after a small wakeup. This prevents system not to rollback on expected reboot.
Add handler function for EVENT 'le_instStat_AppInstallEvent'
This event provides a notification of when an application is installed.
Remove handler function for EVENT 'le_instStat_AppInstallEvent'
Add handler function for EVENT 'le_instStat_AppUninstallEvent'
This event provides a notification of when an application is uninstalled.
Remove handler function for EVENT 'le_instStat_AppUninstallEvent'
Load the specified kernel module that was bundled with a Legato system.
- Returns
- LE_OK if the module has been successfully loaded into the kernel.
- LE_NOT_FOUND if the named module was not found in the system.
- LE_FAULT if errors were encountered when loading the module, or one of the module's dependencies.
- LE_DUPLICATE if the module has been already loaded into the kernel.
Unload the specified module. The module to be unloaded must be one that was bundled with the system.
- Returns
- LE_OK if the module has been successfully unloaded from the kernel.
- LE_NOT_FOUND if the named module was not found in the system.
- LE_FAULT if errors were encountered during the module, or one of the module's dependencies unloading.
- LE_DUPLICATE if the module has been already unloaded from the kernel.
Add handler function for EVENT 'le_update_Progress'
Register for notification of the progress of a given update.
Remove handler function for EVENT 'le_update_Progress'
Starts an update.
Progress is reported via the progress handler callback.
- Returns
- LE_OK if accepted.
- LE_BUSY if another update is in progress.
- LE_UNAVAILABLE if the system is still in "probation" (not marked "good" yet).
Install the update
- Returns
- LE_OK if installation started.
- LE_BUSY if package download is not finished yet.
- LE_FAULT if there is an error. Check logs
Ends an update session. If the update isn't finished yet, cancels it.
Function to get error code when update fails.
- Returns
- Error code of encountered error.
- ERR_NONE if update is in any other state.
Get the index of the currently running system.
- Returns
- The index of the running system.
Gets the hash ID for a given system.
- Returns
- LE_OK if no problems are encountered.
- LE_NOT_FOUND if the given index does not correspond to an available system.
- LE_OVERFLOW if the supplied buffer is too small.
- LE_FORMAT_ERROR if there are problems reading the hash for the system.
Get the index for the previous system in the chain, using the current system as a starting point.
- Returns
- The index to the system that's previous to the given system. -1 is returned if the previous system was not found.
Prevent all updates (and roll-backs) until further notice.
Allow updates to go ahead.
Prevent the probation period from ending.
- Returns
- false if lock failed (for example if not in a probation period).
Cancels a call to LockProbation(), allow the probation period to end.
- Note
- Must match previous successful call to LockProbation().
Marks the system "good", ending the probation period.
- Returns
- LE_OK The system was marked Good
- LE_BUSY Someone holds a probation lock
- LE_DUPLICATE Probation has expired - the system has already been marked
Marks the system "bad" and triggers a roll-back to a "good" system.
- Note
- Ignored if the probation period has already ended. Also, the roll-back may be delayed if someone is deferring updates using le_updateCtrl_Defer().
Get the current system state.
- Note
- Can only be called if updates have been deferred or if a probation lock is held. Otherwise the system state could change between the time this function is called and when the return value is checked.
Kicks the watchdog timer.
Once the watchdog has been kicked it must be kicked again before the expiration of the current effective timeout else the configured WatchdogAction will be executed.
Set a time out.
The watchdog is kicked and a new effective timeout value is set. The new timeout will be effective until the next kick at which point it will revert to the original value.
Get the watchdog timeout configured for this process
- Returns
- LE_OK The watchdog timeout is configured and returned
- LE_NOT_FOUND The watchdog timeout is not set
Get the max watchdog timeout configured for this process
- Returns
- LE_OK The max watchdog timeout is configured and returned
- LE_NOT_FOUND The max watchdog timeout is not set
Gets the application's current state.
- Returns
- TAF_APPMGMT_STATE_STOPPED – App is not running.
- TAF_APPMGMT_STATE_STARTED – App is running.
Gets the application's version.
- Returns
- LE_BAD_PARAMETER – Bad parameter(s).
- LE_NOT_FOUND – App not found.
- LE_OK – Success.
Starts an app.
- Returns
- LE_DUPLICATE – App is already running.
- LE_BUSY – System is busy.
- LE_FAULT – Failure.
- LE_OK – Success.
- Note
- Installed apps are activated in a probation state when started for the first time.
Stops an app.
- Returns
- LE_NOT_FOUND – App not found or not currently running; see note.
- LE_OK – Success.
- Note
- Installed apps are not stopped if they are running in a Probation state.
Uninstalls an app.
- Returns
- LE_NOT_FOUND – App not found.
- LE_BUSY – System is busy.
- LE_FAULT – Failure.
- LE_OK – Success.
- Note
- Installed app is not allow to uninstall if in probation state.
Creates an app list.
- Returns
- Non-null pointer – The reference to the app list.
- Null pointer – Internal error.
Deletes app list.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_OK – Success.
Gets the first app.
- Returns
- Non-null pointer – The reference to the first app.
- Null pointer – Internal error or empty list.
Gets the next app based on the current position in the list.
- Returns
- Non-null pointer – The reference to the next app.
- Null pointer – Internal error or empty list.
Gets app information.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_OK – Success.
- Note
- Get static information when creating app list.
Closes the stream reference.
Creates a new connector.
- Returns
- Reference to the audio stream, NULL on error.
Deletes a connected connector.
- Note
- This function will not return if passed a bad reference.
Connects a connector for an audio stream reference.
- Returns
- LE_OK Success.
- LE_FAULT Failure.
- Note
- This function will not return if passed a bad reference.
Disconnects a connector for an audio stream reference.
- Note
- This function will not return if passed a bad reference.
Opens an audio stream reference for speaker use.
- Returns
- Reference to the audio stream, NULL on error.
Opens an audio stream reference for microphone use.
- Returns
- Reference to an audio stream, NULL on error.
Opens an audio stream reference for voice Rx.
- Returns
- Reference to an audio stream, NULL on error.
Opens an audio stream reference for voice Tx.
- Returns
- Reference to an audio stream, NULL on error.
DTMF playback for inband.
- Note
- Applicable only for voice streams.
Mutes an audio stream.
- Returns
- LE_OK Success.
- LE_FAULT Failure.
Unmutes an audio stream.
- Returns
- LE_OK Success.
- LE_FAULT Failure.
Opens a stream for audio playback.
- Returns
- Reference to an audio stream, NULL on error.
Plays a file on a playback stream.
- Returns
- LE_FAULT Failure.
- LE_BAD_PARAMETER Invalid stream reference.
- LE_BUSY Already active.
- LE_OK Success.
Opens the audio stream for recording.
- Returns
- Reference to an audio stream, NULL on error.
Records a file on the recorder stream.
- Returns
- LE_FAULT Failure.
- LE_BAD_PARAMETER Invalid stream reference.
- LE_BUSY Already active.
- LE_OK Success.
Add handler function for EVENT 'taf_audio_Media'
This event provides information on player/recorder stream events.
Remove handler function for EVENT 'taf_audio_Media'
Add handler function for EVENT 'taf_audio_DtmfDetector'
This event provides information on DTMF decoding for the specified streamRef.
Remove handler function for EVENT 'taf_audio_DtmfDetector'
Stops the file playback or recording.
- Returns
- LE_OK Success.
- LE_FAULT Failure.
Sets the volume.
- Returns
- LE_FAULT Failure.
- LE_OK Success.
Gets the volume.
- Returns
- LE_FAULT Failure.
- LE_OK Success.
Enables noise suppression.
- Returns
- LE_FAULT Failure.
- LE_OK Success.
Enables echo cancellation.
- Returns
- LE_FAULT Failure.
- LE_OK Success.
Disables noise suppression.
- Returns
- LE_FAULT Failure.
- LE_OK Success.
Gets echo cancellation status.
- Returns
- LE_FAULT Failure.
- LE_OK Success.
Gets noise suppression status.
- Returns
- LE_FAULT Failure.
- LE_OK Success.
Opens an audio stream reference for I2S Rx interface use.
- Note
- Set the sampling rate using taf_audio_SetSamplePcmSamplingRate after creating the stream reference and before connecting, otherwise the defalut sampling rate will be 16000.
- Returns
- Reference to the audio stream, NULL on error.
Opens an audio stream reference for I2S Tx interface use.
- Note
- Set the sampling rate using taf_audio_SetSamplePcmSamplingRate after creating the stream reference and before connecting, otherwise the defalut sampling rate will be 16000.
- Returns
- Reference to the audio stream, NULL on error.
Opens an audio stream reference for PCM Rx interface use.
- Note
- Set the sampling rate using taf_audio_SetSamplePcmSamplingRate after creating the stream reference and before connecting, otherwise the defalut sampling rate will be 16000.
- Returns
- Reference to the audio stream, NULL on error.
Opens an audio stream reference for PCM Tx interface use.
- Note
- Set the sampling rate using taf_audio_SetSamplePcmSamplingRate after creating the stream reference and before connecting, otherwise the defalut sampling rate will be 16000.
- Returns
- Reference to the audio stream, NULL on error.
Sets the sampling rate of a stream reference.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
Gets the sampling rate of the stream reference.
- Returns
- LE_FAULT Failed.
- LE_OK Function succeeded.
Sets the channel number for the stream reference.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets the channel number of the recorder stream reference.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Sets the encoding format of a recorder stream reference.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets the encoding format of a recorder stream reference.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
- Note
- A client calling this function with either an invalid streamRef or null out pointer parameter will be killed and the function will not return.
Creates a CAN interface.
- Returns
- Reference to the created CAN interface.
- Null when attempt failed.
- Note
- The process exits if an invalid or existing tag is passed.
Sets a filter to receive CAN frame for the given frame ID.
- Returns
- LE_OK – Filter successfully set.
- LE_OUT_OF_RANGE – Frame ID greater than 29 bits.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Enables loopback message sending from the given CAN interface (can0/can1/..).
- Returns
- LE_OK – Local loopback successfully enabled.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Disables loopback message sending from the given CAN interface (can0/can1/..).
- Returns
- LE_OK – Local loopback successfully disabled.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Enables receiving messages sent from the same CanInterface reference.
- Returns
- LE_OK – Reception of the application's own sent messages successfully enabled.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Disables receiving messages sent from the same CanInterface reference.
- Returns
- LE_OK – Reception of the application's own sent messages successfully disabled.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Checks whether the device supports FD frame or not.
- Returns
- True – FD frame supported.
- False – FD frame not supported.
- Note
- The process exits if an invalid reference is passed.
Enables CAN FD frame, if the device supports FD frame.
- Returns
- LE_OK – CAN FD frame successfully enabled.
- LE_UNSUPPORTED – CAN FD frame not supported.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Checks whether the CAN FD frame is enabled or not.
- Returns
- True – CAN FD frame is enabled.
- False – CAN FD frame is not enabled.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_can_CanEvent'
CAN event.
Remove handler function for EVENT 'taf_can_CanEvent'
Creates a CAN frame.
- Returns
- Reference to the created CAN frame.
- Null when attempt failed.
- Note
- The process exits if an invalid reference or existing tag is passed.
Sets the data payload.
- Returns
- LE_OK – Data payload successfully set.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Sets the frame type to send.
- Returns
- LE_OK – Frame type successfully set.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Sends a CAN frame.
- Returns
- LE_OK – CAN frame successfully sent.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Deletes a created CAN interface.
- Returns
- LE_OK – Created CAN interface successfully deleted.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Deletes a created CAN frame.
- Returns
- LE_OK – Created CAN frame successfully deleted.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Starts a synchronous data cellular session for the given profile reference.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Parameter is invalid or couldn't create the data call.
- LE_OUT_OF_RANGE – PDP type is unknown.
- LE_DUPLICATE – If the data session is already connected for the given profile.
- LE_IN_PROGRESS – The profile is in use and a data call is in progress.
- LE_TIMEOUT – Timed out when attempting to make the data call.
- LE_FAULT – Failed.
Starts (asynchronously) a cellular data session for the given profile reference.
- Returns
- None.
Stops (synchronously) a cellular data session for the given profile reference.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Can't find a data call.
- LE_OUT_OF_RANGE – PdpType type is unknown.
- LE_BAD_PARAMETER – Call context is NULL.
- LE_TIMEOUT – Timeout to stop a data call.
- LE_IN_PROGRESS – The profile is in use and a data call is in progress.
- LE_FAULT – Failed.
Stops (asynchronously) a cellular data session for the given profile reference.
- Returns
- None.
Gets a connected data call interface name.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_NOT_POSSIBLE – Invalid status.
- LE_NOT_FOUND – Cannot find the interface name.
Add handler function for EVENT 'taf_dcs_SessionState'
The data call session event.
Remove handler function for EVENT 'taf_dcs_SessionState'
Add handler function for EVENT 'taf_dcs_RoamingStatus'
Event to report roaming status.
Remove handler function for EVENT 'taf_dcs_RoamingStatus'
Gets the roaming status.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response timed out.
- LE_FAULT – Failed.
Gets the connected data session IPv4 address.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
Gets the connected data session IPv4 gateway address.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
Gets the connected data session primary and secondary DNS IPv4 addresses.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
Gets the connected data session IPv6 address.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
Gets the connected data session IPv6 gateway address.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
Gets the connected data session primary and secondary DNS IPv6 addresses.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
Gets the data session's current state.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
Checks if the data session is IPv4.
- Returns
- True – IPv4.
- False – Not IPv4 or the profile reference is invalid.
Checks if the data session is IPv6.
- Returns
- True – IPv6.
- False – Not IPv6 or the profile reference is invalid.
Gets the connected data session data bearer technology.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
Gets the data profile list.
- Note
- For Dual Sim-Single Active (DSSA) mode and Dual Sim-Dual Active (DSDA) mode, this API gets the data profile list with phone ID 1.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the data profile list with the specified phone ID.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the default profile index.
- Returns
- uint32 – The profile index.
Gets the default phone ID and profile index.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Sets the default profile index corresponding to the specified profile index.
- Note
- For Dual Sim-Single Active (DSSA) mode and Dual Sim-Dual Active (DSDA) mode, this API sets the data profile with default phone ID 1.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Sets the default profile corresponding to the specified phone ID and profile index.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Gets the profile reference for the given profile index.
- Note
- For Dual Sim-Single Active (DSSA) mode and Dual Sim-Dual Active (DSDA) mode, this API gets the profile reference with phone ID 1.
- Returns
- NULL – Error.
- Others – The profile reference.
Gets the profile reference for the given phone ID and profile index.
- Returns
- NULL – Error.
- Others – The profile reference.
Gets the profile index for the given profile reference.
- Returns
- uint32 – The profile index. 0 – Failed
Gets the phone ID for the given profile reference.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_NOT_FOUND – Profile reference was not found.
- LE_FAULT – Failed.
Sets the data profile APN name.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Profile reference was not found.
- LE_FAULT – Failed.
Gets the data profile APN name.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
- LE_OVERFLOW – Apn size is smaller than APN_NAME_MAX_BYTES.
Gets the data profile APN types.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed.
Sets the data profile PDP type.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Profile reference was not found.
- LE_FAULT – Failed.
Gets the data profile PDP type.
- Returns
- AF_DCS_PDP_UNKNOWN – Unknown.
- AF_DCS_PDP_IPV4 – IPV4.
- AF_DCS_PDP_IPV6 – IPV6.
- AF_DCS_PDP_IPV4V6 – IPV4 and IPV6.
Set the data profile authentication type and username/password.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Could not retrieve the profile information.
- LE_FAULT – Failed.
Gets the data profile authentication type and username/password.
- Returns
- LE_OK – Succeeded.
- LE_OUT_OF_RANGE – The size of username or password is invalid.
- LE_NOT_FOUND – Failed.
Gets the data profile index by the interface name.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_NOT_FOUND – Failed.
Gets the phone ID by the interface name.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_NOT_FOUND – Failed.
Gets the reference of a DataID service. If there is no service, a new one will be created.
- Returns
- Reference to the service instance.
- NULL if not allowed to create the service.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagDataID_RxReadDIDMsg'
This event provides information about the received ReadDID message.
Remove handler function for EVENT 'taf_diagDataID_RxReadDIDMsg'
Sends a response message for the received ReadDID message.
- Note
- This function must be called to send a response if receiving a message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagDataID_RxWriteDIDMsg'
This event provides information about the received ReadDID message.
Remove handler function for EVENT 'taf_diagDataID_RxWriteDIDMsg'
Gets the data record of the received WriteDID message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Sends a response message for the received WriteDID message.
- Note
- This function must be called to send a response if receiving a message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Removes the DID service.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid svcRef.
Add handler function for EVENT 'taf_diagDIDBackend_ReadDID'
This event provides information about the received ReadDID message.
Remove handler function for EVENT 'taf_diagDIDBackend_ReadDID'
Add handler function for EVENT 'taf_diagDIDBackend_WriteDID'
This event provides information about the received ReadDID message.
Remove handler function for EVENT 'taf_diagDIDBackend_WriteDID'
Sends a response message for the WriteDID message.
- Note
- This function must be called to send a response if receiving a message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Gets the reference to a Reset service, if there's no Reset service, a new one will be created.
- Returns
- Reference to the service instance.
- NULL if not allowed to create the service.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagReset_RxMsg'
This event provides information on Rx Reset message.
Remove handler function for EVENT 'taf_diagReset_RxMsg'
Sends a response message for the Rx Reset message.
- Note
- This function must be called to send a response if receiving a message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Removes the Reset service.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid svcRef.
Gets the reference to a RoutineControl service, if there's no RoutineControl service, a new one will be created.
- Returns
- Reference to the service instance.
- NULL if not allowed to create the service.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagRoutineCtrl_RxMsg'
This event provides information on Rx RoutineControl message.
Remove handler function for EVENT 'taf_diagRoutineCtrl_RxMsg'
Gets the RoutineControl option record of the Rx RoutineControl message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Sends a response message for the Rx RoutineControl message.
- Note
- This function must be called to send a response if receiving a message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Removes the RoutineControl server service.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid svcRef.
Add handler function for EVENT 'taf_diagSecBackend_SesTypeCheck'
This event provides information on Rx session control type.
Remove handler function for EVENT 'taf_diagSecBackend_SesTypeCheck'
Sends a response message for the condition check of session control type.
- Note
- This function must be called to send a response if receiving a message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagSecBackend_SesChange'
This event provides information on session control type change.
Remove handler function for EVENT 'taf_diagSecBackend_SesChange'
Gets the reference of a security service. If there is no security service, a new one will be created.
- Returns
- Reference to the service instance.
- NULL if not allowed to create the service.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagSecurity_RxSesTypeCheck'
This event provides information on Rx session control type.
Remove handler function for EVENT 'taf_diagSecurity_RxSesTypeCheck'
Sends a response message for the condition check of Rx session control type.
- Note
- This function must be called to send a response if receiving a message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagSecurity_SesChange'
This event provides information on session control type change.
Remove handler function for EVENT 'taf_diagSecurity_SesChange'
Gets the current session control type.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid svcRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagSecurity_RxSecAccessMsg'
This event provides information about the Rx security access message.
Remove handler function for EVENT 'taf_diagSecurity_RxSecAccessMsg'
Gets the payload length of the Rx security access message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Gets the payload of the Rx security access message. The payload can be either securityAccessDataRecord or securityKey based on request accessType.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_OVERFLOW – Payload size is too small.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Sends a response message for the Rx security access message.
- Note
- This function must be called to send a response if receiving a message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Removes the security service.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid svcRef.
Gets the reference to a Diag update service, if there's no Diag update service, a new one will be created.
- Returns
- Reference to the service instance.
- NULL if not allowed to create the service.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagUpdate_RxFileXferMsg'
This event provides information on RequestFileTransfer message.
Remove handler function for EVENT 'taf_diagUpdate_RxFileXferMsg'
Gets the file path and name of the Rx RequestFileTransfer message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_OVERFLOW – Payload size is too small.
- Note
- The process exits if an invalid reference is passed.
Gets the data format ID of the Rx RequestFileTransfer message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Gets the size of the uncompressed file of the Rx RequestFileTransfer message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Gets the size of the compressed file of the Rx RequestFileTransfer message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Sets the file position into RequestFileTransfer response message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef or wrong modeOfOperation.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Sets the fileSizeUncompressedOrDirInfoLength and fileSizeCompressed into RequestFileTransfer response message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef or wrong modeOfOperation.
- LE_NOT_FOUND – Reference not found.
- LE_OVERFLOW – file size more than UINT32_MAX.
- Note
- The process exits if an invalid reference is passed.
Sends a response message for the Rx RequestFileTransfer message.
- Note
- This function must be called to send a response if receiving a RequestFileTransfer message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagUpdate_RxXferDataMsg'
This event provides information on TransferData message.
Remove handler function for EVENT 'taf_diagUpdate_RxXferDataMsg'
Gets the block sequence counter of the Rx TransferData message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Gets the the data request record length of the Rx TransferData message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Gets the transfer data request record of the Rx TransferData message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_OVERFLOW – Payload size is too small.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Sends a response message for the Rx TransferData message.
- Note
- This function must be called to send a response if receiving a TransferData message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Add handler function for EVENT 'taf_diagUpdate_RxXferExitMsg'
This event provides information on RequestTransferExit message.
Remove handler function for EVENT 'taf_diagUpdate_RxXferExitMsg'
Gets the length of the received RequestTransferExit message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Gets the transfer exit request parameter record of the Rx RequestTransferExit message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_OVERFLOW – Payload size is too small.
- LE_NOT_FOUND – Reference not found.
- Note
- The process exits if an invalid reference is passed.
Sends a response message for the Rx RequestTransferExit message.
- Note
- This function must be called to send a response if receiving a RequestTransferExit message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid rxMsgRef.
- LE_NOT_FOUND – Reference not found.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid reference is passed.
Removes the Update server service.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid svcRef.
Add handler function for EVENT 'taf_ecall_StateChange'
eCall state change event handler.
Remove handler function for EVENT 'taf_ecall_StateChange'
Creates an eCall reference.
- Returns
- Reference to the emergency call.
- NULL if the emergency call can not be created.
Releases (frees) a call reference according to the given eCall reference.
Switches to eCall only mode according to the given phone ID.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Switches to persistent eCall Only mode according to the given phone ID.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Exits eCall Only mode and switches to Normal mode according to the given phone ID.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Gets the ecall operating mode according to the given phone ID.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Sets the MSD version.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Note
- Currently, only MSD version 2 and 3 are supported.
Gets the MSD version.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid parameters.
- Note
- Currently, only MSD version 2 and 3 are supported.
Sets the vehicle type.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Get vehicle type.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- LE_BAD_PARAMETER – Invalid parameters.
Sets the vehicle identification number.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- LE_BAD_PARAMETER – Invalid parameters.
Gets the vehicle identification number.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- LE_BAD_PARAMETER – Invalid parameters.
Sets the vehicle propulsion storage type.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Reads the vehicle propulsion storage type.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Sets the MSD transmission mode. The API is not supported on this platform.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- LE_UNSUPPORTED – Not supported.
Reads the MSD transmission mode. The API is not supported on this platform.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- LE_UNSUPPORTED – Not supported.
Sets the latitude and longitude for MSD transmission.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
Sets the position delta N-1 for MSD transmission.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
- Note
- The process exits when an invalid eCall reference is given.[IN] First longitude delta. 1 Unit = 100 miliarcseconds, which is approximately 3m maximum value: 511 = 0 0'51.100'' (+- 1580m) minimum value: -512 = -0 0'51.200'' (+- -1583m)
Sets the position delta N-2 for MSD transmission.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
- Note
- The process exits when an invalid eCall reference is given.[IN] Second longitude delta. 1 Unit = 100 miliarcseconds, which is approximately 3m maximum value: 511 = 0 0'51.100'' (+- 1580m) minimum value: -512 = -0 0'51.200'' (+- -1583m)
Sets the number of passengers according to the given eCall reference.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
- Note
- The process exits when an invalid eCall reference is given.
Sets the optional additional data for MSD transmission.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
- Note
- The process exits when an invalid eCall reference is given.
Resets the optional additional data for MSD transmission.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
- Note
- The process exits when an invalid eCall reference is given.
Sets the location of impact for Euro NCAP additional data.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
- Note
- The process exits when an invalid eCall reference is given.
Sets the rollover detected for Euro NCAP additional data.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
- Note
- The process exits when an invalid eCall reference is given.
Resets the rollover detected for Euro NCAP additional data.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
- Note
- The process exits when an invalid eCall reference is given.
Sets the IIDeltaV for Euro NCAP additional data.
- Returns
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_DUPLICATE – The MSD has already been imported.
- Note
- The process exits when an invalid eCall reference is given.
Imports the PDU MSD according to the given eCall reference. The maximum MSD length is 255 bytes for private eCall and 140 bytes for other eCall.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_OVERFLOW – The size of the MSD buffer is wrong.
- Note
- The process exits if an invalid eCall reference is passed.
Exports the PDU MSD according to the given eCall reference.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_OVERFLOW – The size of the MSD buffer is wrong.
- LE_NOT_FOUND – The MSD is not imported or updated.
- LE_FAULT – Failed.
- Note
- The process exits if an invalid eCall reference is passed.
Updates the eCall MSD in modem to be sent to a Public Safety Answering Point (PSAP) when requested.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Starts an automatic emergency call with a standard PAN European/KSA/UAE PSAP number(112/911/999) or a voice call with the long PSAP number by taf_ecall_SetPsapNumber() according to the given eCall reference.
- Returns
- LE_OK – Succeeded.
- LE_BUSY – eCall session is already in progress.
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
Starts a manual emergency call with a standard PAN European/KSA/UAE PSAP number(112/911/999) or a voice call with the long PSAP number by taf_ecall_SetPsapNumber() according to the given eCall reference.
- Returns
- LE_OK – Succeeded.
- LE_BUSY – eCall session is already in progress.
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
Starts a test eCall with a configured telephone number stored in the USIM or a long PSAP number set by taf_ecall_SetPsapNumber().
- Returns
- LE_OK – Succeeded.
- LE_BUSY – eCall session is already in progress.
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
Initiates a private eCall.
- Returns
- LE_OK – Succeeded.
- LE_BUSY – eCall session is already in progress.
- LE_BAD_PARAMETER – Bad eCall reference.
- LE_FAULT – Failed.
- Note
- Currently, only SA525M platform are supported.
Ends the ongoing eCall according to the given eCall reference.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- LE_BAD_PARAMETER – Bad eCall reference.
Answers the incoming eCall according to the given eCall reference.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- LE_BAD_PARAMETER – Bad eCall reference.
Gets the currrent eCall state according to the given eCall reference.
- Returns
- The current state of the given eCall.
- Note
- The process exits if an invalid eCall reference is passed.
Gets the current eCall type according to the given eCall reference.
- Returns
- The current type of the given eCall.
- Note
- Passing a bad or null pointer to this function results in a fatal error and the function may not return.
Gets the platform-specific reason for a recently terminated call according to the given eCall reference.
- Returns
- The platform-specific termination code.
- Note
- The API is not supported in this platform.
Gets the end reason for a recently terminated eCall.
- Returns
- The termination reason.
- Note
- Passing a bad or null pointer to this function results in a fatal error and the function may not return.
Sets the public safely answering point (PSAP) phone number for eCall.
- Note
- The PSAP number is applicable in manually or automatically dialed eCalls. It is also applicable to test eCalls that are dialed intentionally for testing, validating, or certifying.
- Warning
- This function doesn't modify the U/SIM content.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- Note
- If the PSAP number is empty or too long (max TAF_SIM_PHONE_NUM_MAX_LEN digits), it is a fatal error and the function will not return.
Gets the PSAP number set with taf_ecall_SetPsapNumber().
- Note
- The PSAP number is applicable in manually or automatically dialed eCalls. It is also applicable to test eCalls that are dialed intentionally for testing, validating, or certifying.
- Warning
- This function doesn't read the U/SIM content.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed or taf_ecall_SetPsapNumber() has never been called before.
- LE_BAD_PARAMETER – The PSAP number is null.
Reads the FDN/SDN numbers from U/SIM to dial a test eCall when the modem is in TAF_ECALL_MODE_FORCED_PERSISTENT_ONLY or TAF_ECALL_MODE_ECALL.
- Note
- If the FDN number is updated with a new number, ensure that the SIM card is refreshed.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Sets the eCall deregistration time in NAD. After an emergency call ends the in-vehicle system stays registered with the network for a specific amount of time, defined by the NAD eCall deregistration time.
- Returns
- LE_OK – Succeeded.
- LE_BUSY – An eCall session is in progress.
- LE_FAULT – Failed.
Gets the eCall deregistration time of the NAD.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Disconnects the NAD from the eCall network. After an emergency call ends the in-vehicle system stays registered with the network for a period of time to facilate callback from the PSAP, but when NAD requires to deregister from the network this API can be used.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Sets the eCall clear down fallback time of the NAD. If the NAD does not receive a clear down indication from network or a clear down message (AL-ACK) from the PSAP during an ecall, then it will trigger an automatic call end when clear down fallback time out.
- Returns
- LE_OK – Succeeded.
- LE_BUSY – An eCall session is in progress.
- LE_FAULT – Failed.
Gets the eCall clear down fallback time of the NAD.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Sets the eCall minimum network registration time of the NAD. After an eCall ends, the NAD shall remain registered on the serving network. During this time, the NAD can automatically receive calls from the PSAP.
- Returns
- LE_OK – Succeeded.
- LE_BUSY – An eCall session is in progress.
- LE_FAULT – Failed.
Gets the eCall minimum network registration time of the NAD.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Gets the eCall HLAP timer state of the NAD.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- LE_BAD_PARAMETER – The HLAP timer type is out of range
Initiates flash access reference map and memory pool.
- Note
- This function should be called once before calling other flash access APIs.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Opens an MTD partition for read and write.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Closes an MTD partition.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets an information about the given MTD partition.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Erases an MTD block.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Reads an MTD page.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Writes MTD page.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Reads an MTD partition.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Writes MTD partition.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Erases MTD partition.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Checks if an MTD block is good.
- Returns
- true – Good block.
- false – Bad block.
Opens UBI volume for read and write.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Closes UBI volume.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets UBI volume information.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Reads UBI volume.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Initiates write size of UBI volume.
- Note
- Users should set the number of bytes before subsequent write operations.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Writes data to UBI volume.
- Note
- Users should keep the context of writing UBI volume.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets the FS-Crypt storage object reference, including initialization for the FS-Crypt directory.
- Returns
- Storage – The FS-Crypt storage object reference.
- NULL – Failure in process.
Removes an FS-Crypt key from the kernel keyring to lock the directory.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter(s).
- LE_NOT_FOUND – The key does not exist or is not provisioned.
- LE_FAULT – Error in process.
Adds an FS-Crypt key to the kernel keyring to unlock the directory.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter(s).
- LE_NOT_FOUND – Key does not exist.
- LE_FAULT – Error in process.
Cleans the entire FS-Crypt directory and encryption key.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter(s).
- LE_NOT_FOUND – Key does not exist.
- LE_FAULT – Error in process.
Reboots the target device to an active slot.
Gets the firmware version.
- Returns
- LE_BAD_PAREMETER – Bad parameter(s).
- LE_OK – Succeeded.
Installs firmware.
- Returns
-
- Note
- Only used for local firmware update.
Configures the pin as an input pin.
- Returns
- LE_OK Succeeded.
- LE_BUSY GPIO is busy or locked by another client.
- LE_IO_ERROR Failed.
Sets an output pin to Active state.
- Warning
- Valid only for output pins.
- Returns
- LE_OK Succeeded.
- LE_BUSY GPIO is busy or locked by another client.
- LE_IO_ERROR Failed.
Sets an output pin to Inactive state.
- Warning
- Valid only for output pins.
- Returns
- LE_OK Succeeded.
- LE_BUSY GPIO is busy or locked by another client.
- LE_IO_ERROR Failed.
Reads the value of an input GPIO pin.
- Returns
- TAF_GPIO_BUSY GPIO pin is locked for the pin.
- TAF_GPIO_OFF GPIO pin voltage is low.
- TAF_GPIO_ON GPIO pin voltage is high.
- Note
- Invalid to read an output pin.
Add handler function for EVENT 'taf_gpio_ChangeEvent'
Registers a callback function to be called when an input pin changes state.
If registering fails, because the handler cannot be registered, setting the edge detection fails, or the GPIO pin is locked by other client then this call returns a NULL reference.
Remove handler function for EVENT 'taf_gpio_ChangeEvent'
Sets the edge detection mode. This function can only be used when a handler is registered in order to prevent interrupts being generated and not handled.
- Returns
- LE_OK Succeeded.
- LE_BUSY GPIO is busy or locked by another client.
- LE_IO_ERROR Failed.
Turns off edge detection of the input GPIO pin.
- Returns
- LE_OK Succeeded.
- LE_BUSY GPIO is busy or locked by another client.
- LE_IO_ERROR Failed.
Checks if the pin is configured as an output.
- Returns
- True if output; false if input.
Checks if the pin is configured as an input.
- Returns
- True if output; false if input.
Returns the I/O name.
- Returns
- Name in string format
Gets the current value of edge sensing.
- Returns
- The current configured edge value.
- Note
- Invalid to read the edge sense of an output pin.
Gets the current value of the pin polarity.
- Returns
- The current pin polarity.
Checks if the pin is currently active.
- Returns
- True if active; false if inactive.
- Note
- This can only be used on output pins.
Gets the total CPU usage from " /proc/stat ".
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets number of CPU core from " /proc/cpuinfo ".
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets the CPU usage of each core from " /proc/stat ". The API provides total CPU usage of each core ranging from 0 to 100 %. The coreID range can be 0 - (cpuCoreNum-1), the result value can be LE_OK.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets the meminfo value from " /proc/meminfo ".
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets the list of available UBI device information.
- Returns
- NULL No information found.
- taf_hms_UbiDevInfoListRef The UBI device Info list object reference.
Gets the first UBI device Info object reference in the list of the UbiDevInfoList retrieved with taf_hms_GetUbiDevInfoList().
- Returns
- NULL No information found.
- taf_hms_UbiDevInfoListRef The UBI device Info object reference.
Deletes the UbiDevInfoList list retrieved with taf_hms_GetUbiDevInfoList().
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_OK – Succeeded.
Gets the next UBI device Info object reference in the list of the UBIInfoList retrieved with taf_hms_GetUBIInfoList().
- Returns
- NULL No information found.
- taf_hms_UbiDevInfoListRef The UBI device Info object reference.
Gets UBI device ID
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets UBI information for current maximum erase count from " /sys/class/ubi/ubi%d/ ".
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets UBI information for bad block count from " /sys/class/ubi/ubi%d/ ".
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets the first UBI volume Info object reference in the list of the UbiVolInfoList retrieved with taf_hms_GetUbiDevInfoList().
- Returns
- NULL No information found.
- taf_hms_UbiVolInfoListRef The UBI device Info object reference.
Gets the next UBI volume Info object reference in the list of the UbiVolInfoList retrieved with taf_hms_GetUbiDevInfoList().
- Returns
- NULL No information found.
- taf_hms_UbiVolInfoListRef The UBI volume Info object reference.
Gets UBI volume ID.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets name of UBI volume.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets size of UBI volume in bytes.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets the list of available MTD Node.
- Returns
- NULL No information found.
- taf_hms_MtdInfoListRef The MtdInfo list object reference.
Deletes the MtdInfoList list retrieved with taf_hms_GetMtdInfoList().
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_OK – Succeeded.
Gets the first MtdInfo object reference in the list of the MtdInfoList retrieved with taf_hms_GetMtdInfoList().
- Returns
- NULL No information found.
- taf_hms_MtdInfoListRef The MtdInfo object reference.
Gets the next MtdInfo object reference in the list of the MtdInfoList retrieved with taf_hms_GetMtdInfoList().
- Returns
- NULL No information found.
- taf_hms_MtdInfoListRef The MtdInfo object reference.
Gets MTD information for name from " /sys/class/mtd/mtd%d/ ".
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets MTD information for block size in bytes.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets MTD information for device ID.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets MTD information for block count.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the International Mobile Equipment Identity (IMEI).
- Returns
- LE_FAULT – Failed to retrieve the IMEI. LE_OVERFLOW – IMEI length exceeds the maximum length. LE_UNSUPPORTED – Not Supported. LE_OK – Succeeded.
Retrieves the Device Model.
- Returns
- LE_FAULT – Failed to retrieve the Device Model. LE_OK – Succeeded.
Retrieves the Kernel Version.
- Returns
- LE_FAULT – Failed to retrieve the Kernel Version. LE_OK – Succeeded.
Retrieves the Modem Version.
- Returns
- LE_FAULT – Failed to retrieve the Modem Version. LE_OK – Succeeded.
Retrieves the TZ Version.
- Returns
- LE_FAULT – Failed to retrieve the TZ Version. LE_OK – Succeeded.
Retrieves the TelAF Version.
- Returns
- LE_FAULT – Failed to retrieve the TelAF Version. LE_OK – Succeeded.
Retrieves the root file system Version.
- Returns
- LE_FAULT – Failed to retrieve the root file system version. LE_OK – Succeeded.
Creates a new key.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_PERMITTED – Key already exists.
- LE_FAULT – Error.
Gets a key by key name.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – The key does not exist or is not provisioned.
- LE_FAULT – Error.
Deletes a key by key reference.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key has a running cryptography session.
- LE_FAULT – Error.
Gets a key's usage.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Key does not exist.
- LE_FAULT – Error.
Sets the maximum number of times a key may be used between system reboots.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned.
Sets the minimum amount of time that elapses between allowed operations using a key.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned.
Sets application data to the key.
When this attribute is provided to the key, the same data must be also provided through taf_ks_CryptoSessionSetAppData() for each cryptographic operation using the key.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned.
Sets the date and time at which the key becomes active. Any attempt to use the key prior to this time will fail.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned.
Sets the date and time at which the key expires for signing and encryption. Any attempt to use a key for signing or encryption after this time will fail.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned.
Sets the date and time at which the key expires for verification and decryption. Any attempt to use a key for verification and decryption after this time will fail.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned.
Provisons or imports a RSA encryption key value to the newly created key.
The impData parameter, if provided, shall hold PKCS#8 DER format of RSA key data for import.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned, is not suitable for this provision, or is not created by the client.
- LE_FAULT – Error.
Provisions or imports a RSA signing key value to the newly created key.
The impData parameter, if provided, shall hold PKCS#8 DER format of RSA key data for import.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned, is not suitable for this provision, or is not created by the client.
- LE_FAULT – Error.
Provisions or imports an ECDSA key value to the newly created key.
The impData parameter, if provided, shall hold PKCS#8 DER format of ECDSA key data for import.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned, is not suitable for this provision, or is not created by the client.
- LE_FAULT – Error.
Provisions or imports an AES key value to the newly created key.
The impData parameter, if provided, shall hold the AES raw key data for import.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned, is not suitable for this provision, or is not created by the client.
- LE_FAULT – Error.
Provisions or imports a HMAC key value to the newly created key.
The impData parameter, if provided, shall hold the HMAC raw key data for import.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is already provisioned, is not suitable for this provision, or is not created by the client.
- LE_FAULT – Error.
Exports a key into the specified key data format.
For asymmetric key exports the x.509 DER format (SubjectPublicKeyInfo) public key. Currently symmetric key exports are not supported.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter(s).
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is not provisioned or the key is not created by the client.
- LE_FAULT – Error.
Creates a cryptographic operation session for a key.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Key does not exist.
- LE_NOT_PERMITTED – Key is not provisioned.
Sets the nonce or IVs for AES GCM, CBC, CTR for a cryptographic session. For AES GCM the nonce size must be 12 bytes, for AES CBC, CTR the IV must be 16 bytes.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Session or key does not exist.
- LE_NOT_PERMITTED – Key is not provisioned or the session is not created by the client.
Sets the application data for a cryptographic session.
This API must be called before taf_ks_CryptoSessionStart() if the key has set the attribute of application data by taf_ks_SetKeyAppData().
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Session or key does not exist.
- LE_NOT_PERMITTED – Key is not provisioned or the session is not created by the client.
Starts the cryptographic session for the given operation. The cryptographic session is automatically deleted if an error occurs.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Session or key does not exist.
- LE_NOT_PERMITTED – Key is not provisioned or the session is not created by the client.
- LE_DUPLICATE – Session is already started.
- LE_FAULT – Error.
Provides AEAD to an AES GCM crypto session started with taf_ks_CryptoSessionStart(). This API can be called multiple times before taf_ks_CryptoSessionProcess() and the cryptographic session will be automatically deleted if an error occurs.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Session or key does not exist.
- LE_NOT_PERMITTED – Key is not provisioned, the session is not created by the client, or the session is not started.
- LE_FAULT – Error.
Provides data to, and possibly receives output from, a running cryptographic session started with taf_ks_CryptoSessionStart(). It can be called multiple times before taf_ks_CryptoSessionEnd() is called. The crypto session is automatically deleted if an error occurs.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Session or the key does not exist.
- LE_NOT_PERMITTED – Key is not provisioned, the session is not created by the client, or the session is not started.
- LE_FAULT – Error.
Finalizes the cryptographic session started with taf_ks_CryptoSessionStart(). This API shall be called once all input data is processed by taf_ks_CryptoSessionProcess(). The cryptographic session will be deleted automatically.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Session or key does not exist.
- LE_NOT_PERMITTED – Key is not provisioned, the session is not created by the client, or the session is not started.
- LE_FAULT – Error.
Aborts the cryptographic session started with taf_ks_CryptoSessionStart(). The cryptographic session will be deleted automatically.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Session or key does not exist.
- LE_NOT_PERMITTED – Key is not provisioned, the session is not created by the client, or the session is not started.
- LE_FAULT – Error.
Add handler function for EVENT 'taf_locGnss_Position'
This event provides information on position.
Remove handler function for EVENT 'taf_locGnss_Position'
Add handler function for EVENT 'taf_locGnss_CapabilityChange'
This event provides information on location capability.
Remove handler function for EVENT 'taf_locGnss_CapabilityChange'
Gets the last updated position sample object reference.
- Returns
- A reference to the last position sample.
- Note
- On failure, the process exits.
Gets the position sample's fix state per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- Note
- If the caller passes an invalid position sample reference or a null pointer to this function, it is a fatal error and the client will be killed.
Releases the position sample per client session.
- Note
- If the caller passes an invalid position sample reference to this function, it is a fatal error and the client will be killed.
Gets the location data (latitude, longitude, horizontal accuracy) per client session.
- Returns
- LE_FAULT Failed to get the location's data
- LE_OUT_OF_RANGE At least one of the retrieved parameters is invalid.
- LE_OK Succeeded.
- Note
- latitudePtr, longitudePtr, and hAccuracyPtr can be set to NULL if not needed.
-
The latitude and longitude values are based on the WGS84 standard coordinate system.
-
The latitude and longitude values are given in degrees with 6 decimal places like: Latitude +48858300 = 48.858300 degrees North Longitude +2294400 = 2.294400 degrees East The latitude and longitude values are given in degrees, minutes, seconds in NMEA frame.
-
In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be valid. Compare them with INT32_MAX.
-
If the caller passes an invalid position sample reference to this function, it is a fatal error and the client will be killed.
Gets the position sample direction as per client session. Direction of movement is the direction that the vehicle or person is actually moving.
- Returns
- LE_FAULT Failed to get the location's data
- LE_OUT_OF_RANGE At least one of the retrieved parameters is invalid.
- LE_OK Succeeded.
- Note
- Direction and direction accuracy are given in degrees with 1 decimal place: 1755 = 175.5 degrees. Direction ranges from 0 to 359.9 degrees, where 0 is True North.
-
If the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be valid. Compare them with INT32_MAX.
-
directionPtr and directionAccuracyPtr can be set to NULL if not needed.
-
If the caller passes an invalid position sample reference to this function, it is a fatal error and the client will be killed.
Gets the position sample's altitude per client session.
- Returns
- LE_FAULT Failed to get the altitude. Invalid position reference provided.
- LE_OUT_OF_RANGE At least one of the retrieved parameters is invalid.
- LE_OK Succeeded.
- Note
- For a 2D position fix, the altitude will be indicated as invalid and set to INT32_MAX
-
In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be valid. Compare them with INT32_MAX.
-
If the caller passes an invalid position reference to this function, it is a fatal error and the client will be killed.
-
altitudePtr and altitudeAccuracyPtr can be set to NULL if not needed.
Gets the position sample's horizontal speed per client session.
- Returns
- LE_FAULT Failed to find the positionSample.
- LE_OUT_OF_RANGE At least one of the retrieved parameters is invalid.
- LE_OK Succeeded.
- Note
- hSpeedPtr and hSpeedAccuracyPtr can be set to NULL if not needed.
-
Horizontal speed is in meters/second with 2 decimal places (3047 = 30.47 meters/second).
-
In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be valid. Compare them with UINT32_MAX.
-
If the caller passes an invalid position sample reference to this function, it is a fatal error and the client will be killed.
- Warning
- The horizontal speed accuracy is platform dependent.
Gets the position sample's vertical speed per client session.
- Returns
- LE_FAULT Failed to find finding the positionSample.
- LE_OUT_OF_RANGE At least one of the retrieved parameters is not valid.
- LE_OK Succeeded.
- Note
- vSpeedPtr and vSpeedAccuracyPtr can be set to NULL if not needed.
-
For a 2D position fix, the vertical speed will be indicated as invalid and set to INT32_MAX.
-
In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be valid. Compare them with INT32_MAX.
-
If the caller passes an invalid position sample reference to this function, it is a fatal error and the client will be killed.
- Warning
- The vertical speed accuracy is platform dependent.
Gets the position sample's UTC leap seconds in advance per client session.
- Returns
- LE_FAULT Failed to get the leap seconds.
- LE_OUT_OF_RANGE The retrieved time accuracy is invalid
- LE_OK Succeeded.
- Note
- If the caller passes an invalid position sample reference or a null pointer to this function, it is a fatal error and the client will be killed.
This function is deprecated; le_gnss_GetLeapSeconds should be used instead.
Gets the position sample's date per client session.
- Returns
- LE_FAULT Failed to get the date.
- LE_OUT_OF_RANGE The retrieved date is invalid.
- LE_OK Succeeded.
- Note
- If the caller passes an invalid position sample reference or null pointers to this function, it is a fatal error and the client will be killed.
Gets the position sample's time per client session.
- Returns
- LE_FAULT Failed to get the time.
- LE_OUT_OF_RANGE The retrieved time is invalid
- LE_OK Succeeded.
- Note
- If the caller passes an invalid position sample reference or null pointers to this function, it is a fatal error and the client will be killed.
Enables the Location service with GNSS state per client session.
- Returns
- LE_FAULT Failed.
- LE_DUPLICATE The Location service state is already enabled.
- LE_NOT_PERMITTED The Location service state is not initialized.
- LE_OK Succeeded.
- Warning
- The settings are platform dependent.
Starts a GNSS session by triggering engine reports to receive the fixes as per client.
- Returns
- LE_FAULT Failed.
- LE_DUPLICATE The Location service state is already started.
- LE_NOT_PERMITTED The Location service state is not initialized or disabled.
- LE_OK Succeeded.
Disables the Location service with GNSS state per client session.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
- Warning
- The settings are platform dependent.
Stops a GNSS session from receiving fixes per client.
- Returns
- LE_FAULT Failed.
- LE_DUPLICATE The Location service is already stopped.
- LE_NOT_PERMITTED The Location service state is not initialized or disabled.
- LE_OK Succeeded.
Sets the GNSS constellation bitmask that needs to be blacklisted per client session.
- Returns
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service state is not initialized, disabled, or active.
- LE_OK Succeeded.
- Warning
- Some constellation types are unsupported depending on the platform.
-
The settings are platform dependent.
- Note
- GPS constellation and SVs cannot be blacklisted.
Gets the GNSS constellation bitmask which are blacklisted per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Add handler function for EVENT 'taf_locGnss_Nmea'
This event provides information about NMEA.
Remove handler function for EVENT 'taf_locGnss_Nmea'
Gets the status of the Location service per client session.
- Returns
- TAF_LOCGNSS_STATE_ACTIVE The Location service is active when the GNSS session is started.
- TAF_LOCGNSS_STATE_READY The Location service is ready when the GNSS session is stopped.
- TAF_LOCGNSS_STATE_DISABLED The Location service is disabled.
Get Satellite Vehicle status per client session.
- Returns
- LE_FAULT Failed to find the positionSample.
- LE_OUT_OF_RANGE At least one of the retrieved parameters is invalid.
- LE_OK Succeeded.
- Note
- In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be valid. Compare them with UINT8_MAX.
-
If the caller passes an invalid position sample reference to this function, it is a fatal error and the client will be killed.
Get location acquisition rate per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service state is not ready.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the TTFF in milliseconds per client session.
- Returns
- LE_BUSY Not fixed position and TTFF cannot be measured.
- LE_NOT_PERMITTED The Location service state is not enabled or not started.
- LE_OK Succeeded.
- LE_FAULT Failed.
- Note
- In case of cold start and warm start, the aiding data for the GNSS engine is deleted and the TTFF in these cases would be precise. The TTFF accuracy is lower with higher acquisition rate and is the most precise acquisition at 100ms (10Hz).
In case of start and hot start, the TTFF only represents the time between starting or restarting to receive the reports and receiving first fix reports since these APIs do not restart the underlying GNSS engine.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the satellite's vehicle information per client session. This API provides information about SVs in view.
- Returns
- LE_FAULT Failed in finding the positionSample.
- LE_OUT_OF_RANGE At least one of the retrieved parameters is invalid.
- LE_OK Succeeded.
- Note
- satId[] can be set to 0 if that information list index is not configured, so all satellite parameters (satConst[], satSnr[], satAzim[], satElev[]) are fixed to 0.
-
For LE_OUT_OF_RANGE returned code, invalid value depends on the field type: UINT16_MAX for satId, TAF_LOCGNSS_SV_CONSTELLATION_UNDEFINED for satConst, false for satUsed, UINT8_MAX for satSnr, UINT16_MAX for satAzim, and UINT8_MAX for satElev.
-
In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be valid.
-
If the caller passes an invalid position sample reference to this function, it is a fatal error and the client will be killed.
Gets the position sample's time accuracy per client session.
- Returns
- LE_FAULT Failed.
- LE_OUT_OF_RANGE The retrieved time accuracy is invalid.
- LE_OK Succeeded.
- Note
- If the caller passes an invalid position sample reference or a null pointer to this function, it is a fatal error and the client will be killed.
Gets the position sample's epoch time per client session.
- Returns
- LE_FAULT Failed to get the epoch time.
- LE_OK Succeeded.
- LE_OUT_OF_RANGE The retrieved time is invalid.
- Note
- The epoch time is the number of seconds elapsed.
-
If the caller passes an invalid position sample reference or a null pointer to this function, it is a fatal error and the client will be killed.
Sets the resolution for the DOP parameters per client session.
- Returns
- LE_OK Succeeded.
-
LE_BAD_PARAMETER Invalid parameter provided.
-
LE_FAULT Failed.
- Note
- The function sets the same resolution to all DOP values returned by taf_locGnss_GetDilutionOfPrecision(). The resolution setting takes effect immediately.
-
The resolution setting is done per client session.
Gets the DOP parameters for the fixed position per client session.
- Returns
- LE_FAULT Failed to find the DOP value.
- LE_OUT_OF_RANGE The retrieved parameter is invalid (set to UINT16_MAX).
- LE_OK Succeeded.
- Note
- The DOP value is given with 3 decimal places by default, i.e., DOP value 2200 = 2.200 The resolution can be modified by calling the
taf_locGnss_SetDopResolution() function.
-
If the caller passes an invalid position sample reference to this function, it is a fatal error and the client will be killed.
Gets leap second information per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed to get the data.
- Note
- Insertion of each UTC leap second is usually decided about six months in advance by the International Earth Rotation and Reference Systems Service (IERS).
-
If the caller passes a null pointer to this function, it is considered a fatal error and the client will be killed.
-
If the return value of a parameter is INT32_MAX/UINT64_MAX, the parameter is not valid.
-
Currently the API is not implemented.
Gets the position sample's GPS time per client session.
- Returns
- LE_FAULT Failed to get the time.
- LE_OUT_OF_RANGE The retrieved time is invalid.
- LE_OK Succeeded.
- Note
- If the caller passes an invalid position sample reference or null pointers to this function, it is a fatal error and the client will be killed.
Sets the Location service acquisition rate per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service state is not ready.
- LE_OUT_OF_RANGE Acquisition rate value is equal to zero.
- Warning
- The settings are platform dependent.
Performs a warm restart of the Location service per client session.
- Returns
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service state is not enabled or not started.
- LE_OK Succeeded.
- Note
- This API has a platform dependent feature.
Performs a cold restart of the Location service per client session.
- Returns
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service state is not enabled or not started.
- LE_OK Succeeded.
Performs a factory restart of the Location service.
- Returns
- LE_UNSUPPORTED Not supported on this platform.
Performs a hot restart of the Location service per client session.
- Returns
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service state is not enabled or not started.
- LE_OK Succeeded.
- Note
- This API can be used to restart the Location service. It is equivalent calling taf_locGnss_Stop() and taf_locGnss_Start().
Returns a bitmask containing all satellite constellations supported on this platform.
- Returns
- LE_OK Succeeded.
-
LE_NOT_PERMITTED The Location service state is not enabled or not started.
-
LE_FAULT Failed.
This API configures the minimum SV elevation angle setting used by the GNSS standard position engine per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE The minimum elevation value is above the range[0,90].
- LE_NOT_PERMITTED The Location service state is not enabled or not started.
- Warning
- The settings are platform dependent.
Starts the Location service in the specified start mode per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_BAD_PARAMETER Invalid start mode.
- LE_DUPLICATE The Location service is already started.
- LE_NOT_PERMITTED The Location service state is not enabled or not started.
- Warning
- The settings are platform dependent.
This API retrieves the minimum SV Elevation configuration used by the modem GNSS standard position engine per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service state is not enabled or not started.
- Note
- If the caller passes n null pointer to this function, it is a fatal error and the client will be killed.
Sets the enabled NMEA sentences using a bitmask per client session.
- Returns
- LE_OK Succeeded.
- LE_BAD_PARAMETER Bitmask value is zero.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not ready.
- Warning
- This function may be subject to limitations depending on the platform.
- Note
- Some NMEA sentences are unsupported depending on the platform. Setting an unsuported NMEA sentence will not report an error but we cannot receive the NMEA callback function to fetch the same.
Gets the bitmask for the enabled NMEA sentences per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_TIMEOUT Timeout occurred.
- LE_NOT_PERMITTED Location service is not active.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
-
Some NMEA sentences are unsupported depending on the platform. We cannot receive the NMEA callback function to fetch the unsupported NMEA sentences.So the bitmask won't get for those NMEA sentences.
Sets the dead reckoning configuration parameters with default mask enabled. By default all DRE parameters mask get enabled while triggering this API. To change the mask taf_locGnss_SetDRConfigValidity() API can be called to set particular DRE parameter mask. The mask gets updated and this API can be called to configure the DRE parameters with the updated mask. This API configures Dead recokining parameters per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE Dead reckoning parameters out of range.
- LE_NOT_PERMITTED Location service is not ready.
- Note
- If the caller passes a null pointer to this function, it is a fatal error, the client will be killed.
Returns a bitmask containing all NMEA sentences supported on this platform per client session.
- Returns
- LE_OK Succeeded.
- LE_NOT_PERMITTED Location service is not ready.
- LE_FAULT Failed.
Sets the engine state for SPE/PPE/DRE/VPE engines per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not ready.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
This API enables/disables robust location feature and enables/disables robust location while device is on E911 per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not active.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
This API retrieves the robust location settings and version information used by the GNSS standard position engine per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not active.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Sets default configuration for secondary bands per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not ready.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the (enabled) secondary band GNSS constellation types per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not ready.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Disables the given secondary band GNSS constellation types per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not ready.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the position sample's magnetic deviation per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service is not in the Active state.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the semi-major and semi-minor horizontal elliptical uncertainty per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service is not in the Active state.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Sets the Lever Arm configuration Parameters per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_BAD_PARAMETER Invalid lever arm parameter provided.
- LE_NOT_PERMITTED The Location service is not in the ready state.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Set the engine type for source of location data per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_BAD_PARAMETER Invalid engine type parameter provided.
- LE_NOT_PERMITTED The Location service is not in the ready state.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the conformity index per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- When robust location is enabled, comformity index will be returned.
-
If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the sensor calibration status and confidence percentage per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the body frame data per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets vehicle reference point based latitude, longitude, and altitude information per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets vehicle reference point based east, north, and up velocity information per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the set of satellite vehicles that are used to calculate position per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets navigation solution mask used to indicate SBAS corrections per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets position technology mask to indicate which technology is used per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the validity of the location information per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the the combination of position engines and location engine type used in calculating the position report per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the reliability of the horizontal and vertical positions per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the elliptical horizontal uncertainty azimuth of orientation, east and north standard deviations per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the elapsed real time and its uncertainity values in nano-second per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_OUT_OF_RANGE If the retrieved parameter is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the information about GNSS measurement usages per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_BAD_PARAMETER The given positionSampleRef is invalid.
- LE_OUT_OF_RANGE The retrieved parameter is invalid.
- LE_NO_MEMORY The array length of measInfoPtr is zero.
- LE_OVERFLOW The array length of measInfoPtr is greater than MEASUREMENT_INFO_MAX.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the status of report in terms of how optimally the report was calculated by the engine per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_BAD_PARAMETER The given positionSampleRef is invalid.
- LE_NO_MEMORY The reportStatus is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the altitude with respect to mean sea level per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_BAD_PARAMETER The positionSampleRef is invalid.
- LE_NO_MEMORY The altMeanSeaLevel is invalid.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the GNSS Satellite Vehicles used in position data per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_BAD_PARAMETER The positionSampleRef is invalid.
- LE_OUT_OF_RANGE The retrieved parameter is invalid.
- LE_NO_MEMORY The array length of sVIdsPtr is zero.
- LE_OVERFLOW The array length of sVIdsPtr is greater than MEASUREMENT_INFO_MAX.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Gets the satellite's vehicle information of a given constellation per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_BAD_PARAMETER The positionSampleRef is invalid.
- LE_OUT_OF_RANGE The retrieved parameter is invalid.
- LE_NO_MEMORY The array length of svInfo is zero.
- LE_OVERFLOW The array length of svInfo is less than available SV of a constellation.
- Note
- If the caller passes an invalid position sample reference to this function, it is a fatal error and the client will be killed.
Sets the minimum GPS week used by the modem GNSS standard position engine (SPE) per client session. This API shall not be called when GNSS state is ACTIVE. Behavior is not defined if client issues a second request of SetMinGpsWeek without waiting for the previous SetMinGpsWeek to finish. Additionally minimum GPS week number shall NEVER be in the future of the current GPS Week.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED The Location service state is not ready.
Gets the minimum GPS week configuration used by the modem GNSS standard position engine (SPE) per client session. If this API is called right after SetMinGpsWeek, the returned setting may not match the one specified in SetMinGpsWeek, as the setting configured via SetMinGpsWeek can not be applied to the GNSS standard position engine(SPE) when the engine is in middle of a session. In poor GPS signal condition, the session may take up to 255 seconds to finish. If after 255 seconds of invoking SetMinGpsWeek, the returned value still does not match, then the caller need to reapply the setting by invoking SetMinGpsWeek again.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NO_MEMORY The minGpsWeekPtr is NULL.
- LE_NOT_PERMITTED The Location service state is not ready.
Gets the GNSS capability information per client session. To know capability bit mask LocCapabilityType.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
Configures the required NMEA sentences per client session. Without prior invocation to this API, all NMEA sentences supported in the system will get generated and delivered to all the clients that register to receive NMEA sentences. The NMEA sentence type configuration is common across all clients and it will affect all clients.
- Returns
- LE_OK Succeeded.
- LE_BAD_PARAMETER the nmeaMask is zero.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not ready.
- Warning
- This function may be subject to limitations depending on the platform.
- Note
- This API call is not incremental and the new NMEA configuration will completely overwrite the previous call to this API.
LE_GNSS_NMEA_MASK_PQXFI is deprecated; LE_GNSS_NMEA_MASK_PTYPE should be used instead.
Gets the XTRA status per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not ready.
Gets GNSS data for data mask, jammer indication, and automatic gain control per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NO_MEMORY The gnssDataPtr is NULL.
Sets the dead reckoning parameters validity mask per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_NOT_PERMITTED Location service is not ready.
Gets Gptp time and its uncertainty per client session.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- Note
- If the caller passes a null pointer to this function, it is a fatal error and the client will be killed.
Add handler function for EVENT 'taf_locPos_Movement'
This event provides information on movement changes.
Remove handler function for EVENT 'taf_locPos_Movement'
Gets the 2D location data (latitude, longitude, horizontal accuracy).
- Returns
- LE_FAULT Failed to get the 2D location data.
- LE_OUT_OF_RANGE One, or more, retrieved parameters is invalid.
- LE_OK Succeeded.
- Note
- latitudePtr, longitudePtr, hAccuracyPtr can be set to NULL if not needed.
Gets the date of the last updated location.
- Returns
- LE_FAULT Failed to get the date.
- LE_OUT_OF_RANGE The retrieved date is invalid.
- LE_OK Succeeded.
- Note
- Currently the API implementation is in progress.
Gets the position fix state.
- Returns
- LE_FAULT Failed to get the position fix state.
- LE_OK Succeeded.
- Note
- In case the function fails to get the position fix state, a fatal error occurs, the function will not return.
Gets the motion data (horizontal speed, horizontal speed accuracy, vertical speed, and vertical speed accuracy).
- Returns
- LE_FAULT Failed to get the motion data.
- LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid (set to INT32_MAX, UINT32_MAX).
- LE_OK Succeeded.
- Note
- hSpeedPtr, hSpeedAccuracyPtr, vSpeedPtr, and vSpeedAccuracyPtr can be set to NULL if not needed.
Gets the position sample's direction. Direction of movement is the direction that the vehicle or person is actually moving.
- Returns
- LE_FAULT Failed to get the direction indication.
- LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
- LE_OK Succeeded.
- Note
- Direction is given in degrees. Direction ranges from 0 to 359 degrees, where 0 is true North degree.
-
directionPtr and directionAccuracyPtr can be set to NULL if not needed.
Gets the position sample's time.
- Returns
- LE_FAULT Failed to get the time.
- LE_OUT_OF_RANGE The retrieved time is invalid.
- LE_OK Succeeded.
Sets the acquisition rate.
- Returns
- LE_OUT_OF_RANGE Acquisition rate is invalid.
- LE_OK Succeeded.
Retrieves the acquisition rate in milliseconds.
- Returns
- Acquisition rate in milliseconds.
Releases the position sample.
- Note
- If the caller is passing an invalid position reference to this function, it is a fatal error and the function will not return.
Gets the 3D location data (latitude, longitude, altitude, horizontal accuracy, vertical accuracy)
- Returns
- LE_FAULT Failed to get the 3D location data.
- LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
- LE_OK Succeeded.
- Note
- latitudePtr, longitudePtr,hAccuracyPtr, altitudePtr, and vAccuracyPtr can be set to NULL if not needed.
Gets the position sample's 2D location (latitude, longitude, horizontal accuracy)
- Returns
- LE_FAULT Failed to find the positionSample.
- LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
- LE_OK Suceeded.
- Note
- If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.
-
latitudePtr, longitudePtr, and horizontalAccuracyPtr can be set to NULL if not needed.
Gets the position sample's altitude.
- Returns
- LE_FAULT Failed to find the positionSample.
- LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
- LE_OK Suceeded.
- Note
- If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.
-
altitudePtr and altitudeAccuracyPtr can be set to NULL if not needed.
Gets the position sample's horizontal speed.
- Returns
- LE_FAULT Failed to find the positionSample.
- LE_OUT_OF_RANGE One, or more, of the retrieved parameters is invalid.
- LE_OK Suceeded.
- Note
- If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.
-
hSpeedPtr and hSpeedAccuracyPtr can be set to NULL if not needed.
Get the position sample's direction
- Returns
- LE_FAULT Failed to find the positionSample.
- LE_OUT_OF_RANGE One of the retrieved parameter is invalid.
- LE_OK Suceeded.
- Note
- Direction is given in degrees. Direction ranges from 0 to 359 degrees, where 0 is true North.
-
If the caller passed an invalid position reference to this function, it is a fatal error and the function will not return.
-
directionPtr and directionAccuracyPtr can be set to NULL if not needed.
Gets the position sample's vertical speed.
- Returns
- LE_FAULT Failed to find the positionSample.
- LE_OUT_OF_RANGE One, or more, of the retrieved parameters is not valid.
- LE_OK Suceeded.
- Note
- If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.
-
vSpeedPtr and vSpeedAccuracyPtr can be set to NULL if not needed.
Sets the resolution for the positioning distance values.
- Returns
- LE_OK Suceeded.
- LE_BAD_PARAMETER Invalid parameter provided.
- Note
- The positioning distance values are: the altitude above sea level, the horizontal position accuracy and the vertical position accuracy. The API sets the same resolution to all distance values. The resolution change request takes effect immediately.
Gets the position sample's fix state.
- Returns
- LE_FAULT Failed to get the position sample's fix state.
- LE_OK Suceeded.
- Note
- If the caller passes an invalid position reference to this function, it is a fatal error and the function will not return.
Gets the position sample date.
- Returns
- LE_FAULT Failed to get the date.
- LE_OUT_OF_RANGE The retrieved date is invalid.
- LE_OK Suceeded.
Requests activation of the Positioning Control service.
- Returns
- Reference to the service activation request; used later to release the request.
- NULL if the service request could not be processed.
Releases the Positioning Control service.
Starts a permanent synchronous data cellular session for the given profile reference.
- Returns
- LE_OK Successfully made the data call.
- LE_NOT_FOUND Parameter is invalid or cannot create the data call.
- LE_OUT_OF_RANGE PDP type is unknown.
- LE_BUSY Profile is in use.
- LE_TIMEOUT Timed out while attempting to make the data call.
- LE_FAULT Failed to make the data call.
Starts a permanent asynchronous data cellular session for the given profile reference.
- Returns
- LE_OK Successfully made the data call.
- LE_NOT_FOUND Parameter is invalid or cannot create the data call.
- LE_OUT_OF_RANGE PDP type is unknown.
- LE_BUSY Profile is in use.
- LE_TIMEOUT Timed out while attempting to make the data call.
- LE_FAULT Failed to make the data call.
Synchronously stops a permanent data cellular session for the given profile reference.
- Returns
- LE_OK Successfully stopped the data call.
- LE_NOT_FOUND Could not find the data call to stop.
- LE_OUT_OF_RANGE PDP type is unknown.
- LE_BAD_PARAMETER Call context is NULL.
- LE_TIMEOUT Timed out while attempting to stop the data call.
- LE_FAULT Failed to stop the data call.
Asynchronously stops a permanent data cellular session for the given profile reference.
- Returns
- LE_OK Successfully stopped the data call.
- LE_NOT_FOUND Could not find the data call to stop .
- LE_OUT_OF_RANGE PDP type is unknown.
- LE_BAD_PARAMETER Call context is NULL.
- LE_TIMEOUT Timed out while attempting to stop the data call.
- LE_FAULT Failed to stop the data call.
Add handler function for EVENT 'taf_mngdConn_DataState'
Events to report data state.
Remove handler function for EVENT 'taf_mngdConn_DataState'
Add handler function for EVENT 'taf_mngdConn_RecoveryState'
Events to report recovery state.
Remove handler function for EVENT 'taf_mngdConn_RecoveryState'
Gets the data reference for the given data ID(as provided in the configuration JSON).
- Returns
- NULL – Error.
- Others – The data reference.
Gets the data reference for the given data name(as provided in the configuration JSON).
- Returns
- NULL – Error.
- Others – The data reference.
Gets the data object ID (as provided in the configuration JSON) for the given data reference.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Data reference not found.
- Appropriate error is returned on failure.
Gets the data object name (as provided in the configuration JSON) for the given data reference.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Data reference not found.
- Appropriate error is returned on failure.
Starts a data session for the given data reference. This API should be used when the value of "AutoStart" is "No" in the configuration file.
The service tracks clients that call StartData for Data objects with AutoStart:No and is used to manage StopData behavior.
- Returns
- LE_OK – Succeeded.
- LE_DUPLICATE – The data connection is already started.
- LE_IN_PROGRESS – The data connection establishment retry is in progress.
- Appropriate error is returned on failure.
Stops a data cellular session for the given data reference.
Data will be stopped only when all clients that have called StartData for data objects with AutoStart:No either stop data or exit.
- Returns
- LE_OK – Succeeded.
- LE_NOT_PERMITTED – If data is auto started by the service, application cannot stop data.
- Appropriate error is returned on failure.
Gets the data connection state information for the given data reference.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- Appropriate error is returned on failure.
Gets the data connection IP addresses for the given data reference. An empty string is returned if either IP address is not available.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- Appropriate error is returned on failure.
Starts the data retry mechanism. If data session is connected, the data session will be disconnected before data retry mechanism is started. This function is asynchronous and applications should monitor taf_mngdConn_DataState_t events.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- Appropriate error is returned on failure.
Cancels a scheduled L1 recovery process. A L1 recovery could be scheduled for one or more data connetions. For a scheduled L1 recovery process to be canceled, this API should be called for all data references for which L1 recovery has been scheduled.
- Returns
- LE_OK – Succeeded.
- LE_NOT_POSSIBLE – A L1 recovery process has not been scheduled.
- LE_NOT_PERMITTED – A L1 recovery process has already started.
- Appropriate error is returned on failure.
Cancels a scheduled L2 recovery process. A L2 recovery could be scheduled for one or more data connetions. For a scheduled L2 recovery process to be canceled, this API should be called for all data references for which L2 recovery has been scheduled.
- Returns
- LE_OK – Succeeded.
- LE_NOT_POSSIBLE – A L2 recovery process has not been scheduled.
- LE_NOT_PERMITTED – A L2 recovery process has already started.
- Appropriate error is returned on failure.
Sends an OTA start message to MRCD.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sends an OTA resume message to MRCD.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sends an OTA end message to MRCD.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sends a message to MRCD to synchronize active and inactive slots.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Add handler function for EVENT 'taf_net_RouteChange'
Event to report route changes.
Remove handler function for EVENT 'taf_net_RouteChange'
Add handler function for EVENT 'taf_net_GatewayChange'
Event to report gateway changes.
Remove handler function for EVENT 'taf_net_GatewayChange'
Add handler function for EVENT 'taf_net_DNSChange'
Event to report DNS changes.
Remove handler function for EVENT 'taf_net_DNSChange'
Add handler function for EVENT 'taf_net_DestNatChange'
Event to report destination NAT change.
Remove handler function for EVENT 'taf_net_DestNatChange'
Gets the interface information list.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Adds or removes a route.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Backs up the current default gateway of the system into DB, including both IPv4 and IPv6.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – No default gateway.
Restores the default gateway of the system from the last backed up one, including IPv4 and/or IPv6. Only gateways backed up and set by the same client session can be restored.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – No backup.
- LE_FAULT – Failed.
Sets the default gateway address received from the interface into the system.
- Returns
- LE_OK – Succeded.
- LE_NOT_FOUND – No gateway address from the interface.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the gateway addresses from the specified interface.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – No gateway address from the interface.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Sets the DNS addresses received from the interface into the system.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – No DNS addresses from the interface.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the DNS addresses from the interface, including IPv4 and IPv6 addresses.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found DNS addresses from the interface.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Adds a destination NAT entry on the default PDN.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Deletes a destination NAT entry on the default PDN.
- Returns
- LE_OK – Success
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failure.
Adds a destination NAT entry to the specified PDN.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Deletes a destination NAT entry from the specified PDN.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the reference to the destination NAT entry list on the default PDN.
- Returns
- NULL – If there was some other error.
- Others – The reference to the destination NAT entry list.
Gets the reference to the destination NAT entry list on the specified PDN.
- Returns
- NULL – If there was some other error.
- Others – The reference to the destination NAT entry list.
Gets the reference to the first destination NAT entry with a list reference.
- Returns
- NULL – Error.
- Others – The reference to the first destination NAT entry.
Gets the reference to the next destination NAT entry with a list reference.
- Returns
- NULL – Error.
- Others – The reference of the next destination NAT entry.
Gets the information of a destination NAT entry with an entry reference.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Deletes the reference to the destination NAT entry list.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Creates a VLAN.
- Note
- To use VLAN bridge and VLAN binding features, set device mode with value 0 first.
- Returns
- NULL – Failure.
- Others – The reference of VLAN.
Sets the priority to a VLAN.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN was not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Removes a VLAN.
- Note
- The system is not allowed to remove a VLAN if the VLAN interface list is not empty.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN was not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets VLAN by the VLAN ID.
- Returns
- NULL – Not found.
- Others – The VLAN reference.
Adds a VLAN interface into the VLAN interface list.
- Note
- Adding the first interface into the VLAN interface list with the same interface type triggers a system reboot if VLAN acceleration is enabled.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN was not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_DUPLICATE – ifType already added into the VLAN.
- LE_FAULT – Failed.
Removes a VLAN interface from the VLAN interface list.
- Note
- Removing the last interface from the VLAN interface list with the same interface type triggers a system reboot if VLAN acceleration is enabled.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN was not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the VLAN interface list.
- Returns
- NULL – If the VLAN was not found or the VLAN interface list is empty.
- Others – The VLAN interface list reference.
Gets the first VLAN interface reference with a list.
- Returns
- NULL – The interface list doesn't exist.
- Others – The first VLAN interface reference.
Gets the next VLAN interface reference with a list.
- Returns
- NULL – The VLAN interface list or the next interface doesn't exist.
- Others – The next VLAN interface reference.
Deletes the VLAN interface list.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN interface list was not found.
- LE_BAD_PARAMETER – Bad parameter.
Gets the interface type of a VLAN interface.
- Returns
- taf_net_VlanIfType_t – VLAN interface type.
- TAF_NET_IFACE_UNKNOWN – VLAN interface was not found.
Gets the VLAN priority of a VLAN interface.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN was not found.
- LE_BAD_PARAMETER – Bad parameter.
Gets the VLAN entry list.
- Returns
- NULL – The VLAN entry list is empty.
- Others – The VLAN entry list reference.
Gets the reference of the first VLAN entry with a list.
- Returns
- NULL – The VLAN entry list doesn't exist.
- Others – The first VLAN entry reference.
Gets the reference of the next VLAN entry with a list.
- Returns
- NULL – The VLAN entry list or the next VLAN doesn't exist.
- Others – The reference of the next VLAN entry.
Deletes the VLAN entry list.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Failed to delete the reference.
- LE_BAD_PARAMETER – Bad parameter.
Gets the VLAN ID by the VLAN entry reference.
- Returns
- 1-4094 – Succeeded.
- others – Failed.
Determines if the VLAN is accelerated or not by the VLAN entry reference.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN was not found.
- LE_BAD_PARAMETER – Bad parameter.
Gets the profile ID bound with a VLAN by the VLAN entry reference.
- Returns
- Others – Succeeded.
- -1 – No binding.
Gets the phone ID bound with a VLAN by the VLAN entry reference.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN was not found.
- LE_BAD_PARAMETER – Bad parameter.
Binds a VLAN with a specified profile ID.
- Note
- Binding VLAN with the default profile ID results in the system automatically rebooting after 5 seconds.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN wass not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Binds a VLAN with a specified phone ID and profile index.
- Note
- Binding a VLAN with the default profile ID results in the system automatically rebooting after 5 seconds.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN wass not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Unbinds a VLAN from previous profile ID.
- Note
- Unbinding VLAN from the default profile ID results in the system automatically rebooting after 5 seconds.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – VLAN wass not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Enables (synchronously) L2TP for unmanaged tunnel state.
- Note
- To use the L2TP feature set device mode with value 1 first.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_FAULT – Failed.
Enables (asynchronously) L2TP for unmanaged tunnel state.
Disables (synchronously) L2TP for unmanaged tunnel state.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_FAULT – Failed.
Disables (asynchronously) L2TP for unmanaged tunnel state.
- Returns
- None.
Determines if L2TP is enabled.
- Returns
- false – L2TP is disabled.
- true – L2TP is enabled.
Determines if maximum segment size (MSS) is enabled.
- Returns
- false – MSS is disabled for L2TP.
- true – MSS is enabled for L2TP.
Determines if maximum transmission unit (MTU) is enabled.
- Returns
- false – MTU is disabled for L2TP.
- true – MTU is enabled for L2TP.
Gets L2TP MTU size.
- Returns
- 0 – Failed.
- Others – Succeeded.
Creates an L2TP tunnel.
- Returns
- NULL – Failed.
- Others – The tunnel reference.
Removes an L2TP tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Sets UDP ports for a tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Adds a session into a tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Removes a session from a tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Starts (synchronously) a tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Starts (asynchronously) a tunnel.
Stops (synchronously) a tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Stops (asynchronously) a tunnel.
- Returns
- None.
Gets tunnel reference by the local tunnel ID.
- Returns
- NULL – Failed.
- Others – The created tunnel reference.
Gets the tunnel entry list.
- Returns
- NULL – Failed.
- Others – The tunnel entry list reference.
Gets the reference of the first tunnel entry.
- Returns
- NULL – Failed.
- Others – The first tunnel entry reference.
Gets the reference of the next tunnel entry.
- Returns
- NULL – Failed.
- Others – The next tunnel entry reference.
Deletes a tunnel entry list.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the encapsulation protocol of a tunnel.
- Returns
- TAF_NET_L2TP_NONE – Failed.
- TAF_NET_L2TP_IP – IP protocol used for encapsulation.
- TAF_NET_L2TP_UDP – UDP protocol used for encapsulation.
Gets the local ID of a tunnel.
- Returns
- 0 – Failed.
- Others – Succeeded.
Gets the peer ID of a tunnel.
- Returns
- 0 – Failed.
- Others – Succeeded.
Gets the local UDP port of a tunnel.
- Returns
- 0 – Failed.
- Others – Succeeded.
Gets the peer UDP port of a tunnel.
- Returns
- 0 – Failed.
- Others – Succeeded.
Gets the peer IPv6 address of a tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the peer IPv4 address of a tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the interface name of a tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
Gets the IP type of a tunnel.
- TAF_NET_L2TP_UNKNOWN – Failed.
- TAF_NET_L2TP_IPV4 – IPv4.
- TAF_NET_L2TP_IPV6 – IPv6.
Gets the session configuration of a tunnel.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Enables (synchronously) the SOCKS proxy service.
- Note
- To use the SOCKS feature, set device mode with value 2 first.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Enables (asynchronously) the SOCKS proxy service.
- Returns
- None.
Disables (synchronously) the SOCKS proxy service.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Disables (asynchronously) the SOCKS proxy service.
- Returns
- None.
Sets the SOCKS authentication method.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Gets the SOCKS authentication method.
- Returns
- TAF_NET_SOCKS_UNKNOWN – Unknown.
- TAF_NET_SOCKS_NONE – No authentication.
- TAF_NET_SOCKS_USER_PASSWD – Username and password.
Sets SOCKS LAN interface.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Gets SOCKS LAN interface.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Adds a username/profile association.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Deletes a username/profile association.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Adds GSB configuration for an interface.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Removes GSB configuration for an interface.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Enables GSB in the system.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Disables GSB in the system.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Gets GSB list.
- Returns
- NULL – Failed.
- Others – The GSB list reference.
Gets the reference of the first GSB.
- Returns
- NULL – Failed.
- Others – The first GSB reference.
Gets the reference of the next GSB.
- Returns
- NULL – Failed.
- Others – The next GSB reference.
Deletes the GSB list.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the interface name of a GSB.
- Returns
- LE_OK – Succeeded.
- LE_NOT_FOUND – Not found.
- LE_BAD_PARAMETER – Bad parameter.
- LE_FAULT – Failed.
Gets the interface type of a GSB.
- Returns
- GSB_UNKNOWN – Unknown type.
- GSB_WLAN_AP – WLAN AP.
- GSB_WLAN_STA – WLAN station.
- GSB_ETH – Ethernet.
Gets the bandwidth of a GSB.
- Returns
- -1 – Failed.
- Others – Succeeded.
Add handler function for EVENT 'taf_pm_StateChange'
TCU state change event of the local process.
Remove handler function for EVENT 'taf_pm_StateChange'
Add handler function for EVENT 'taf_pm_StateChangeEx'
TCU state change event of the local process.
- Note
- This is supported only on SA525M.
Remove handler function for EVENT 'taf_pm_StateChangeEx'
Creates a new wakeup source.
- Returns
- Reference to wakeup source (to be used later for acquiring/releasing).
- Null when attempt failed.
Acquires a passed wakeup source reference.
- Returns
- LE_OK Wakeup source successfully acquired.
- LE_BAD_PARAMETER Invalid wakeup source reference.
- LE_FAULT Failed.
Releases a previously acquired wakeup source.
- Returns
- LE_OK Wakeup source successfully released.
- LE_BAD_PARAMETER Invalid wakeup source reference.
- LE_FAULT Failed.
Gets the current system state of the local process.
- Returns
- State of the system.
Sets the power state to all the Virtual Machines.
- Returns
- LE_OK Successfully changed the state of device.
- LE_FAULT Failed.
- Note
- This is supported only on SA525M.
Sets the power state to the respective Virtual Machine.
- Returns
- LE_OK Successfully changed the state of Virtual Machine.
- LE_FAULT Failed.
- Note
- This is supported only on SA525M.
Gets the list of available Virtual Machines.
- Returns
- non-null pointer – The Virtual Machines List reference.
- null pointer – Internal error.
- Note
- This is supported only on SA525M.
Gets the first Virtual Machine name.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Empty list.
- Note
- This is supported only on SA525M.
Gets the next Virtual Machine name based on the current position in the list.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – The end of the list.
- Note
- This is supported only on SA525M.
Deletes the Vitual Machine list.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_OK – Succeeded.
- Note
- This is supported only on SA525M.
Receives the acknowledgement from clients for state change.
- Note
- This is supported only on SA525M.
Add handler function for EVENT 'taf_radio_NetRegReject'
Event to report network registration rejection.
Remove handler function for EVENT 'taf_radio_NetRegReject'
Add handler function for EVENT 'taf_radio_RatChange'
Event to report RAT change.
Remove handler function for EVENT 'taf_radio_RatChange'
Add handler function for EVENT 'taf_radio_NetRegStateEvent'
Event to report network registration state.
Remove handler function for EVENT 'taf_radio_NetRegStateEvent'
Add handler function for EVENT 'taf_radio_PacketSwitchedChange'
Event to report packet switched state changes.
Remove handler function for EVENT 'taf_radio_PacketSwitchedChange'
Add handler function for EVENT 'taf_radio_SignalStrengthChange'
Event to report signal strength change.
Remove handler function for EVENT 'taf_radio_SignalStrengthChange'
Add handler function for EVENT 'taf_radio_ImsRegStatusChange'
Event to report IMS registration status.
Remove handler function for EVENT 'taf_radio_ImsRegStatusChange'
Add handler function for EVENT 'taf_radio_OpModeChange'
Event to report operating mode changes.
Remove handler function for EVENT 'taf_radio_OpModeChange'
Add handler function for EVENT 'taf_radio_NetStatusChange'
Event to report network status changes.
Remove handler function for EVENT 'taf_radio_NetStatusChange'
Add handler function for EVENT 'taf_radio_ImsStatusChange'
Event to report IMS status.
Remove handler function for EVENT 'taf_radio_ImsStatusChange'
Add handler function for EVENT 'taf_radio_CellInfoChange'
Event to report cell info change.
Remove handler function for EVENT 'taf_radio_CellInfoChange'
Sets the radio power state.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets the radio power state.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Registers to network using automatic mode.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response time out.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Registers to network using manual mode.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response time out.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Registers to network asynchronously using manual mode.
Gets the network registration mode.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response time out.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets platform-specific network registration error code.
- Returns
- Platform-specific network registration error code.
Gets 2G/3G band capabilities.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets LTE band capabilities.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sets 2G/3G band preferences.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets 2G/3G band preferences.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sets LTE band preferences.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets LTE band preferences.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Adds a preferred operator.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response timed out.
- LE_DUPLICATE – Duplicate preferred operator.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Removes a preferred operator.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response timed out.
- LE_NOT_FOUND – Preferred operator not found.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Deletes the preferred operators list.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Preferred operator not found.
- LE_OK – Succeeded.
Creates a preferred operators list.
- Returns
- Non-null pointer – The preferred operators list reference.
- Null pointer – Internal error or no preferred operators list.
- Note
- At most 1 preferred operator list per slot.
Gets the first preferred operator.
- Returns
- Non-null pointer – The first preferred operator reference.
- Null pointer – Internal error or empty list.
Gets the next preferred operator based on the current position in the list.
- Returns
- Non-null pointer – The next preferred operator reference.
- Null pointer – Internal error or empty list.
Gets the details of the given preferred operator.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Preferred operator not found.
- LE_OK – Succeeded.
Gets the RAT in use.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response timed out.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sets the RAT preferences.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets the RAT preferences.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response timed out.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets the network registration state.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response timed out.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets the packet switch state.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response timed out.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sets signal strength indication thresholds.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters
- LE_FAULT – Failed.
Sets signal strength indication delta.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters
- LE_FAULT – Failed.
Gets the signal quality.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response timed out.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Creates signal metrics.
- Returns
- Non-null pointer – The signal metrics reference.
- Null pointer – Internal error.
Deletes signal metrics.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Preferred operator not found.
- LE_OK – Succeeded.
Gets RAT bitmask of signal metrics.
- Returns
- taf_radio_RatBitMask_t – RAT bitmask of signal metrics.
Gets GSM signal metrics.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_UNAVAILABLE – GSM unavailable.
- LE_OK – Succeeded.
Gets UMTS signal metrics.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_UNAVAILABLE – UMTS unavailable.
- LE_OK – Succeeded.
Gets LTE signal metrics.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_UNAVAILABLE – LTE unavailable.
- LE_OK – Succeeded.
Gets CDMA signal metrics.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_UNAVAILABLE – CDMA unavailable.
- LE_OK – Succeeded.
Gets NR5G signal metrics.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_OK – Succeeded.
Gets cell ID.
- Returns
- UINT32_MAX – Internal error.
- Others – Cell ID.
Gets NR cell ID.
- Returns
- UINT64_MAX – Internal error.
- Others – Cell ID.
Gets the location area code.
- Returns
- UINT32_MAX – Internal error.
- Others – Location area code.
Gets the LTE tracking area code.
- Returns
- UINT16_MAX – Internal error.
- Others – LTE tracking area code.
Gets the NR tracking area code.
- Returns
- INT32_MAX – Internal error.
- Others – NR tracking area code.
Gets E-UTRA absolute radio frequency channel number.
- Returns
- UINT16_MAX – Internal error.
- Others – E-UTRA absolute radio frequency channel number.
Gets NR absolute radio frequency channel number.
- Returns
- INT32_MAX – Internal error.
- Others – Absolute radio frequency channel number.
Gets timing advance.
- Returns
- UINT32_MAX – Internal error.
- Others – Timing advance.
Gets physical LTE cell ID.
- Returns
- UINT16_MAX – Internal error.
- Others – Physical LTE cell ID.
Gets physical NR5G cell ID.
- Returns
- UINT32_MAX – Internal error.
- Others – Physical NR5G cell ID.
Gets the GSM base station identity code.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_TIMEOUT – Response time out.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets the primary scrambling code.
- Returns
- UINT16_MAX – Internal error.
- Others – Primary scrambling code.
- Note
- Only applicable for WCDMA.
Gets the current network's short name.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_TIMEOUT – Time out.
- LE_OK – Succeeded.
Gets the current MCC and MNC.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Performs celluar network scan and gets the network scan information list reference.
- Returns
- Non-null pointer – The network scan information list reference.
- Null pointer – Internal error.
Asynchronously performs a celluar network scan.
Gets the reference of the first operator in the network scan information list.
- Returns
- Non-null pointer – The reference of the first operator in the network scan list.
- Null pointer – Internal error.
Gets the reference of the next operator based on the current position in the network scan information list.
- Returns
- Non-null pointer – The reference to the next operator in the network scan list.
- Null pointer – Internal error or the end of the list.
Deletes the network scan information list reference.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_OK – Succeeded.
Gets MCC and MNC of a network scan operator.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_OK – Succeeded.
Gets the network name of a network scan operator.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_OK – Succeeded.
Gets Radio Access Technology of a network scan operator.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_OK – Succeeded.
Checks if a scan operator's network is in use.
- Returns
- True – Network is in use.
- False – Invalid reference or network is not in use.
Checks if the scan operator's network is available.
- Returns
- True – Network is available.
- False – Invalid reference or network is available.
Checks if scan operator is home network.
- Returns
- True – It is home network.
- False – Invalid reference or it is not home network.
Checks if scan operator's network is forbidden.
- Returns
- True – Network is forbidden.
- False – Invalid reference or network is forbidden.
Performs celluar network scan with Physical Cell ID.
- Returns
- Non-null pointer – The PCI network scan information list reference.
- Null pointer – Internal error.
Asynchronously performs celluar network scan with physical cell ID.
Gets the first reference in the PCI network scan information list.
- Returns
- Non-null pointer – The reference of the first PCI network scan information in the list.
- Null pointer – Internal error.[IN] PCI network scan information list reference.
Gets the next reference in the PCI network scan information list.
- Returns
- Non-null pointer – The reference of the next PCI network scan information in the list.
- Null pointer – Internal error.[IN] PCI network scan information list reference.
Deletes the PCI network scan information list reference.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Reference not found.
- LE_OK – Succeeded.[IN] PCI network scan information list reference.
Gets the first reference of PLMN info of PCI network scan information.
- Returns
- Non-null pointer – The reference of the first PLMN information.
- Null pointer – Internal error.
Gets the next reference of PLMN info of PCI network scan information.
- Returns
- Non-null pointer – The reference of the next PLMN information.
- Null pointer – Internal error.
Gets the cell ID of PCI network scan information.
- Returns
- Cell ID.
Gets the global cell ID of PCI network scan information.
- Returns
- Global Cell ID.
Gets PLMN network MCC and MNC of PCI network scan information.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_OK – Succeeded.
Gets neighbor cells information.
- Returns
- Non-null pointer – The signal metrics reference.
- Null pointer – Internal error.
Deletes neighbor cells information.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Neighbor cells reference not found.
- LE_OK – Succeeded.
Gets the first neighbor cell information.
- Returns
- Non-null pointer – The first neighbor cell information reference.
- Null pointer – Internal error.
Gets the next neighbor cell information.
- Returns
- Non-null pointer – The next neighbor cell information reference.
- Null pointer – Internal error.
Gets neighbor Cell ID.
- Returns
- Cell ID
Gets Location Area Code of neighbor cell.
- Returns
- Location Area Code.
Gets signal strength of neighbor cell.
- Returns
- signal strength in dBm.
Gets Radio Access Technology of neighbor cell.
- Returns
- Radio Access Technology.
Gets Physical Cell ID of neighbor LTE cell.
- Returns
- Physical Cell ID, valid from 0 to 503.
Gets Physical Cell ID of neighbor NR5G cell.
- Returns
- Physical Cell ID.
Gets Base Station Identity Code of neighbor GSM cell.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_NOT_FOUND – Neighbor cells reference not found.
- LE_OK – Succeeded.
Gets the network status reference.
- Returns
- Non-null pointer – Network status reference.
- Null pointer – Internal error.
Gets the RAT service status.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Gets the CS capabilitiy of LTE network.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Gets the IMS reference.
- Returns
- Non-null pointer – IMS reference.
- Null pointer – Internal error.
Gets the IMS registration status.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Gets the IMS service status.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Gets the PDP error code.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Sets the IMS service enablement configuration parameters.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Gets the IMS service enablement configuration parameters.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Sets the user agent.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Gets the user agent.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Gets the DCNR and ENDC mode status.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed
- LE_OK – Succeeded.
Gets the long name of the network.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_TIMEOUT – Time out.
- LE_OK – Succeeded.
Gets the details of the total SIM count and maximum active SIM count.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Gets the RAT capabilities supported by hardware and SIM based on a given phone ID.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_TIMEOUT – Time out.
Sets the hysteresis in units of 0.1 dBm. which is an optional parameter for signal strength indication.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters
- LE_FAULT – Failed.
Sets the hysteresis time in milliseconds which is an optional parameter for signal strength indication.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Bad parameters
- LE_FAULT – Failed.
Add handler function for EVENT 'taf_sim_NewState'
SIM card state change event.
Remove handler function for EVENT 'taf_sim_NewState'
Add handler function for EVENT 'taf_sim_AuthenticationResponse'
Authentication response.
Remove handler function for EVENT 'taf_sim_AuthenticationResponse'
Checks whether SIM card is present or absent.
- Returns
- True – SIM card present.
- False – SIM card absent.
Gets the state of the SIM card for the given slotId.
- Returns
- Current of SIM card state.
Checks whether the SIM card is ready or not
- Returns
- True – SIM card is present and ready to use, i.e., unlocked.
- False – SIM card is absent or restricted to use, i.e., locked.
Retrieves the SIM's ICCID.
- Returns
- LE_OK ICCID was read successfully.
- LE_OVERFLOW Buffer size is too small.
- LE_BAD_PARAMETER Invalid parameters.
- LE_FAULT Failed to retrieve the ICCID.
Retrieves the IMSI for the SIM.
- Returns
- LE_OVERFLOW Buffer size is too small.
- LE_BAD_PARAMETER Invalid parameters.
- LE_FAULT Failed to retrieve the IMSI.
- LE_OK IMSI retrieved successfully.
Retrieves the name of the carrier on which this subscription is made.
- Returns
- LE_OVERFLOW Buffer size is too small.
- LE_BAD_PARAMETER Invalid parameters.
- LE_FAULT Failed to retrieve the carrier name.
- LE_OK Carrier name retrieved successfully.
Retrieves the phone number for the SIM subscription.
- Returns
- LE_OVERFLOW Buffer size is too small.
- LE_BAD_PARAMETER Invalid parameters.
- LE_FAULT Failed to retrieve the phone number.
- LE_OK Phone number retrieved successfully.
Retrieves the MNC and MCC of the carrier to which the phone is connected.
- Returns
- LE_OVERFLOW Buffer size is too small.
- LE_BAD_PARAMETER Invalid parameters.
- LE_FAULT Failed to retrieve the phone number.
- LE_OK Phone number retrieved successfully.
Gets the slotId of currently selected SIM card.
- Returns
- slotId of currently selected card.
Selects a SIM.
- Returns
- LE_FAULT Failed to select SIM card.
- LE_OK SIM card selected successfully.
Unlocks the Sim card for an app by entering PIN.
- Returns
- LE_BAD_PARAMETER Invalid SIM slot ID.
- LE_UNDERFLOW PIN code length is too short (minimum 4 digits).
- LE_FAULT Failed to send unlock SIM card by PIN request.
- LE_OK Successfully sent unlock SIM by password request.
Changes the password used in PIN1/PIN2 lock.
- Returns
- LE_BAD_PARAMETER Invalid SIM slot ID.
-
LE_UNDERFLOW PIN code length is too short (minimum 4 digits).
-
LE_FAULT Failed to send change password for lock SIM card request.
-
LE_OK Successfully sent change SIM lock password request.
Gets the available retry count of PIN tries.
- Returns
- LE_BAD_PARAMETER Invalid SIM slot ID.
- LE_FAULT Failed to get the number of remaining PIN insertion tries.
- A positive value Retry count value.
Gets the remaining PUK try count.
- Returns
- LE_BAD_PARAMETER Invalid SIM slot ID.
- LE_FAULT Failed to get the number of remaining PUK insertion tries.
- A positive value Retry count value.
Disables PIN1 or FDN lock.
- Returns
- LE_BAD_PARAMETER Invalid SIM slot ID.
-
LE_UNDERFLOW PIN code length is too short (minimum 4 digits).
-
LE_FAULT Failed to send disable lock SIM card request.
-
LE_OK Successfully sent disable SIM lock request.
Enables PIN1 or FDN lock.
- Returns
- LE_BAD_PARAMETER Invalid SIM slot ID.
- LE_UNDERFLOW PIN code length is too short (minimum 4 digits).
- LE_FAULT Failed to send enable lock SIM card request.
- LE_OK Successfully sent the enable SIM lock request.
Unlocks the SIM card for an app by entering PUK and new PIN.
- Returns
- LE_BAD_PARAMETER Invalid SIM slot ID.
- LE_OUT_OF_RANGE PUK length is not correct (8 digits).
- LE_UNDERFLOW PIN code length is too short (minimum 4 digits).
- LE_FAULT Failed to send unlock SIM card request.
- LE_OK Successfully sent the unlock SIM request.
Requests eUICC identifier(EID) for the slot.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
Enables or disables the automatic SIM selection.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
Gets the automatic SIM selection.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
Opens a logical channel to the SIM.
- Returns
- LE_OK Successfully opened logical channel request.
- LE_BAD_PARAMETER Invalid parameter.
- LE_FAULT Failed to open logical channel.
Closes a previously opened logical channel to the SIM.
- Returns
-
-
- LE_OK Succeeded.
- LE_BAD_PARAMETER Invalid parameter.
- LE_NOT_FOUND Failed to select the SIM card.
- LE_FAULT Failed to transmit APDU.
Exchanges APDUs with the SIM on a basic channel.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed to transmit APDU.
- LE_BAD_PARAMETER Invalid parameter.
- LE_NOT_FOUND Failed to select the SIM card.
Sends a command to the SIM.
- Returns
- LE_OK Succeeded.
- LE_FAULT Failed.
- LE_BAD_PARAMETER A parameter is invalid.
- LE_NOT_FOUND - The function failed to select the SIM card for this operation
- The requested SIM file is not found
- LE_OVERFLOW Response buffer is too small to copy the SIM answer.
- LE_UNSUPPORTED The platform does not support this operation.
Switches the given SIM to the emergency call subscription. The eUICC reboots after switching the profile and the client app must wait for it.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid SIM identifier.
- LE_FAULT – Unexpected error.
- Note
- The eUICC should be in the Ready state.
-
Ensure the emergency profile is available on the eUICC or an error will be thrown.
Switches the given SIM to the commercial subscription. The eUICC reboots after switching the profile and the client app must wait for it.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid SIM identifier.
- LE_FAULT – Unexpected error.
- Note
- The eUICC should be in the Ready state.
-
Ensure the commercial profile is available on the eUICC or an error will be thrown.
Powers up or down the current SIM.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
- LE_NOT_FOUND – Failed to select the SIM card.
- LE_BAD_PARAMETER – Incorrect parameter(s).
- Note
- For SIM power cycle operation, it must wait until the SIM state is LE_OFF before powering on the SIM, otherwise power up SIM will fail.
Reset the SIM.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Checks if the emergency profile is activated for the SIM slot.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid SIM identifier or null ECS pointer.
- LE_NOT_FOUND – Cannot determine the current selected subscription.
- LE_FAULT – Unexpected error.
Add handler function for EVENT 'taf_sim_IccidChange'
ICCID information.
Remove handler function for EVENT 'taf_sim_IccidChange'
Creates an empty FPLMN list to insert the FPLMN operators.
- Returns
- Reference to the list object.
- Null pointer if not able to create list reference.
Adds the FPLMN network into the newly created FPLMN list. If fplmnListRef, mcc, or mnc is not valid then this function will kill the calling client.
- Returns
- LE_FAULT Function failed.
- LE_OK Function succeeded.
- LE_OVERFLOW The FPLMN operator cannot be inserted into the FPLMN list.
Reads the first FPLMN network from the list of FPLMN objects retrieved with taf_sim_ReadFPLMNList(). If fplmnListRef, mccPtr, or mncPtr is not valid then this function will kill the calling client.
- Returns
- LE_FAULT Function failed.
- LE_OK Function succeeded.
- LE_OVERFLOW MCC/MNC string size is greater than the string length parameter that has been given to this function.
Reads the next FPLMN network from the list of FPLMN objects retrieved with le_sim_ReadFPLMNList(). If fplmnListRef, mccPtr, or mncPtr is not valid then this function will kill the calling client.
- Returns
- LE_FAULT Function failed.
- LE_OK Function succeeded.
- LE_OVERFLOW MCC/MNC string size is greater than string length parameter that has been given to this function.
Reads the FPLMN list from the SIM.
- Returns
- Reference to the list object.
- Null pointer if the FPLMN list is not able to read from the SIM.
Deletes the FPLMN list created by le_sim_ReadFPLMNList() or le_sim_CreateFPLMNList(). If fplmnListRef is not valid then this function will kill the calling client.
- Note
- On failure, the process exits so that users do not have to worry about checking the returned reference for validity.
Writes the FPLMN list into the SIM. If fplmnListRef is not valid then this function will kill the calling client.
- Returns
- LE_FAULT Function failed.
- LE_OK Function succeeded.
Retrieves the total number of SIM slots in the device.
- Returns
- LE_FAULT Failed to retrieve the slot count.
-
LE_OK The slot count was retrieved successfully.
Add handler function for EVENT 'taf_simRsim_Message'
Event to notify and send a message.
Remove handler function for EVENT 'taf_simRsim_Message'
Sends a message to the remote SIM service service which sends the message to the modem.
- Returns
- LE_OK – Successfully sent the message.
- LE_BAD_PARAMETER – Length of the message is too long.
Add handler function for EVENT 'taf_simRsp_ProfileDownload'
Event for profile download.
Remove handler function for EVENT 'taf_simRsp_ProfileDownload'
Add handler function for EVENT 'taf_simRsp_ProfileUserConsent'
User consent of profile management.
Remove handler function for EVENT 'taf_simRsp_ProfileUserConsent'
Add handler function for EVENT 'taf_simRsp_ProfileConfirmationCode'
Event for confirmation code of profile.
Remove handler function for EVENT 'taf_simRsp_ProfileConfirmationCode'
Request eUICC identifier (EID) for the slot.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Adds a new profile to the eUICC card and downloads and installs the profile on the eUICC.
- Returns
-
-
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Enables or disables the profile which allows switching another profile on the eUICC card.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Updates the profile's nick name.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Requests a list of profiles supported by the eUICC card.
- Returns
- LE_OK – Succeeded.
- LE_FAULT– Failed.
Sets the Subscription Manager Data Preparation (SM-DP+) address on the eUICC. If the SM-DP+ address length is zero then the existing SM-DP+ address on the eUICC is removed.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Gets the SM-DP+ address and the Subscription Manager Discovery Server (SMDS) address configured on the eUICC.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Provides user consent required for downloading and installing a profile. This API should be called in response to a ProfileUserConsent event.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Provides the confirmation code required for downloading and installing the profile. This API should be called in response to a ProfileConfirmationCode event.
- Returns
- LE_OK – Succeeded.
- LE_FAULT – Failed.
Returns the opaque type (ProfileListNode) reference for a profile, specified using the profile index.
- Returns
- ProfileListNode type reference – Succeeded.
- NULL – Failed.
Returns profileIndex for a profile, specified using the ProfileListNode type reference.
- Returns
- uint32_t type profile index.
Returns the profile type for a profile, specified using the ProfileListNode type reference.
- Returns
-
Gets the ICCID for a profile, specified using the ProfileListNode type reference.
- Returns
- LE_OK – Successful in getting ICCID.
- LE_FAULT – Failure in getting the ICCID.
Returns whether or not the specified profile is active.
- Returns
- True – Profile is active.
- FaLSE – Profile is inactive or not found.
Gets the nickname for the specified profile.
- Returns
- LE_OK – Successful.
- LE_FAULT – Error occurred while getting the nickname.
Gets the name for the specified profile.
- Returns
- LE_OK – Successful.
- LE_FAULT – Error occurred while getting the name.
Gets the SPN for the specified profile.
- Returns
- LE_OK - Successful
- LE_FAULT - Error occurred while getting the SPN.
Gets the Icon type for the specified profile.
- Returns
-
Gets the ProfileClass for the specified profile.
- Returns
-
Gets the Mask for the specified profile.
- Returns
- uint32 – Mask for the profile specified.
Add handler function for EVENT 'taf_simSap_Message'
Event to notify and send a message.
Remove handler function for EVENT 'taf_simSap_Message'
Sends a message to the service which the sends it to the subscription module.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Message is too long.
Creates a message list for accessing messages.
- Returns
- Created message list reference.
Deletes a message list.
Add handler function for EVENT 'taf_sms_RxMsg'
Event for handler usage.
Remove handler function for EVENT 'taf_sms_RxMsg'
Add handler function for EVENT 'taf_sms_FullStorageEvent'
Event for information on full storage notifications.
Remove handler function for EVENT 'taf_sms_FullStorageEvent'
Gets the first message in the given list.
- Returns
- The first message reference in the message list.
Gets the next message in the list.
- Returns
- The next message reference from the message list.
Gets the message's send status.
- Returns
- The message send status.
Gets the message's read status.
- Returns
- The message's read status.
Gets the message's lock status.
- Returns
- The message's lock status.
Creates a new message to send.
- Returns
- The created message reference.
Sets the message's destination phone number.
- Returns
- LE_BAD_PARAMETER – Invalid input.
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sets the message's text.
- Returns
- LE_BAD_PARAMETER – Invalid input.
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sets the message's binary content.
- Returns
- LE_BAD_PARAMETER – Invalid input.
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sets the message's UCS2 content.
- Returns
- LE_BAD_PARAMETER – Invalid input.
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sets the message's PDU format.
- Returns
- LE_BAD_PARAMETER – Invalid input.
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sets the message's callback function.
- Returns
- LE_BAD_PARAMETER – Invalid input.
- LE_NOT_FOUND – Invalid message.
- LE_OK – Succeeded.
Sets the phone ID function for the message; phone ID must be 1 or 2 (for DSDA use case).
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_OK – Succeeded.
Deletes a message from the message list, if there is no message list reference, it deletes the message from storage.
Gets the message's phone ID (only for the messages stored in the SIM or created by the client).
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_NOT_PERMITTED – Invalid message type.
- LE_BAD_PARAMETER – Invalid phone ID pointer.
- LE_OK – Succeeded.
Gets the message sender's phone number.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_NOT_PERMITTED – Invalid message type.
- LE_FAULT – Invalid input string.
- LE_OVERFLOW – String overflow.
- LE_OK – Succeeded.
Gets the message's text.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Invalid input string.
- LE_OVERFLOW – String overflow.
- LE_OK – Succeeded.
Gets the message's binary data.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Invalid input string.
- LE_OVERFLOW – String overflow.
- LE_OK – Succeeded.
Gets the message's UCS2 encoding.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Invalid input string.
- LE_OVERFLOW – String overflow.
- LE_OK – Succeeded.
Gets the message's PDU data.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Invalid input string.
- LE_OVERFLOW – String overflow.
- LE_OK – Succeeded.
Gets the message's PDU length.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Invalid input string.
- LE_OVERFLOW – String overflow.
- LE_OK – Succeeded.
Gets the message's type.
- Returns
- The message type.
Gets the message's format.
- Returns
- The message format.
Gets the message's text length.
- Returns
- The message's text length.
Send the message.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_BAD_PARAMETER – Invalid phone ID.
- LE_FORMAT_ERROR – Failed to encode message.
- LE_OK – Succeeded.
Deletes a message from storage.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_BAD_PARAMETER – Invalid storage.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Deletes all messages from storage.
- Note
- In the case of HLOS storage, this API only deletes unlocked messages.
- Returns
- LE_BAD_PARAMETER – Invalid storage.
- LE_FAULT: Failed.
- LE_OK – Succeeded.
Marks a message's status as read.
Marks a message's status as unread.
Marks a message's lock status as locked; the message cannot be deleted from storage.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_NOT_PERMITTED – Message is locked or is not stored in HLOS.
Marks a message's lock status as unlocked; the message can be deleted from storage.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_NOT_PERMITTED – Message is not locked or is not stored in HLOS.
Encrypts a message which is stored in HLOS.
- Returns
- LE_NOT_FOUND – Invalid message.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
- LE_NOT_PERMITTED – Message is not stored in HLOS.
Gets the SMS center address for the specified phone ID.
- Returns
- LE_OVERFLOW – Input buffer len is not enough.
- LE_FAULT – Internal error.
- LE_TIMEOUT – Timeout occurred.
- LE_BAD_PARAMETER – Invalid input.
- LE_OK – Succeeded.
Sets the SMS center address for the specified phone ID.
- Returns
- LE_OVERFLOW – Input buffer len is not enough.
- LE_FAULT – Internal error.
- LE_TIMEOUT – Timeout occurred.
- LE_OK – Succeeded.
Sets the preferred SMS storage place.
- Returns
- LE_FAULT – Failed.
- LE_TIMEOUT – Timeout occurred.
- LE_UNSUPPORTED – Input storage is not suppported.
- LE_BAD_PARAMETER – Invalid input.
- LE_OK – Succeeded.
Gets the preferred SMS storage place.
- Returns
- LE_FAULT – Failed.
- LE_TIMEOUT – Timeout occurred.
- LE_OK – Succeeded.
Sends a PDU message.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Sends a PDU message with phone ID.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Activates cell broadcast for the specified phone ID.
- Returns
- LE_TIMEOUT – Timeout occurred.
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Deactivates cell broadcast for the specified phone ID.
- Returns
- LE_FAULT – Failed.
- LE_TIMEOUT – Timeout occurred.
- LE_OK – Succeeded.
Adds cell broadcast message range of identifier for the specified phone ID.
- Returns
- LE_BAD_PARAMETER – Invalid input.
- LE_TIMEOUT – Timeout occurred.
- LE_FAULT – Internal error.
- LE_OK – Succceeded.
Removes cell broadcast range of message identifiers for the specified phone ID.
- Returns
- LE_BAD_PARAMETER – Invalid input.
- LE_TIMEOUT – Timeout occurred.
- LE_FAULT – Internal error.
- LE_OK – Succceeded.
Gets the SOME/IP client ID of client-service-instance on default network interface.
- Returns
-
Gets the SOME/IP client ID of client-service-instance on a dedicated network interface. The ifName shall match the device name specified in one of the JSON files.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid parameters.
- LE_NOT_FOUND – Client ID is not found.
Requests a client-service-instance on default network interface and returns the reference to the client-service-instance.
- Returns
- Reference to the client-service-instance.
- NULL if invalid parameters.
Requests a client-service-instance on a dedicated network interface and returns the reference to the client-service-instance. The ifName shall match the device name specified in one of the JSON files.
- Returns
- Reference to the client-service-instance.
- NULL if invalid parameters.
Releases a client-service-instance.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid parameters.
- LE_NOT_PERMITTED – The service is not requested by the client.
- LE_BUSY – The service still has active handlers or pending requests.
Gets the service state.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid parameters.
- LE_NOT_PERMITTED – The service is not requested by the client.
Gets the service version.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid parameters.
- LE_NOT_PERMITTED – The service is not requested by the client.
- LE_UNAVAILABLE – Service is unavailable.
Add handler function for EVENT 'taf_someipClnt_StateChange'
This event provides information on the service state change.
Remove handler function for EVENT 'taf_someipClnt_StateChange'
Creates a request message and sets the destination.
- Returns
- Reference to the request message.
- NULL if invalid parameters.
Sets the request to a non-return-request(MT_REQUEST_NO_RETURN). By default, it is MT_REQUEST.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid input parameters.
- LE_NOT_PERMITTED – The message is not created by the client.
Uses TCP to send the request. By default, it uses UDP.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid input parameters.
- LE_NOT_PERMITTED – The message is not created by the client.
Sets the timeout in milliseconds for waiting for the response. By default, the timeout is 30000 ms. 0 means NEVER time out.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid input parameters.
- LE_NOT_PERMITTED – The message is not created by the client.
Sets the payload data of the request. By default, the payload is empty.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid input parameters.
- LE_NOT_PERMITTED – The message is not created by the client.
Deletes a request message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid input parameters.
- LE_NOT_PERMITTED – The message is not created by the client.
Sends an asynchronous request message. The response handler will be called once the response is received or any errors occur.
NOTE: The request message will be automatically deleted after calling this API.
Enables an event group by adding an event into the group.
NOTE: This API can be called multiple times if there is more than one event to be added into the group. Currently, one event can only be added into one group, and one event group can be enabled only by one client.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid input parameters.
- LE_NOT_PERMITTED – The service is not requested by the client, or the event group is subscribed or enabled by another client, or the event is already added into another group.
- LE_DUPLICATE – The event is already in this group.
Disables an event group and removes all events from the group.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid input parameters.
- LE_NOT_PERMITTED – The service is not requested by the client, or the event group is subscribed or already enabled by another client.
- LE_DUPLICATE – The event group is not enabled.
Subscribes an event group of a service.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid input parameters.
- LE_NOT_PERMITTED – The service is not requested by the client, or the event group is not enabled or already enabled by another client.
- LE_DUPLICATE – The event group is already subscribed.
Unsubscribes an event group of a service.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid input parameters.
- LE_NOT_PERMITTED – The service is not requested by the client, or the event group is not enabled or already enabled by another client.
- LE_DUPLICATE – The event group is not subscribed.
Add handler function for EVENT 'taf_someipClnt_EventMsg'
This event provides information on an event message.
Remove handler function for EVENT 'taf_someipClnt_EventMsg'
Gets the reference to a server-service-instance on default network interface.
- Returns
- Reference to the service instance.
- NULL if not allowed to represent the service.
Gets the reference to a server-service-instance on a dedicated network interface. The ifName shall match the device name specified in one of the JSON files.
- Returns
- Reference to the service instance.
- NULL if not allowed to represent the service.
Sets the major and minor version for the server-service-instance. The default major version is 0x00, the minor version is 0x00000000.
NOTE: This API must be called before OfferService() if needed.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client or already offered.
Sets up an UDP server and/or a TCP server with given port(s) for the server-service-instance.
NOTE: This API must be called before OfferService() if needed.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client or already offered.
Offers a server-service-instance. The TCP port or/and UDP port must be set if the service need to be offered remotely, otherwise it's only offered locally.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client.
- LE_DUPLICATE – The service is already offered.
Stops offering a server-service-instance. It also stops offering all events of the service.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client.
- LE_DUPLICATE – The service is already stopped.
Enables an event by adding it to an event group.
NOTE: This API must be called before offerEvent() and can be called for multiple times if the event need to be added into more than one event groups.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client or if the event is already offered.
Sets the event type for an event of a service.
NOTE: The default event type is ET_EVENT and the API must be called before OfferEvent() if needed.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client or if the event is already offered.
Sets the cycle time for an periodic event notification(ET_EVENT) of a service. By default the cycle time is 0 which means periodic event notification is disabled.
NOTE: This API has no effect for field notification(ET_FIELD) and must be called before OfferEvent() if needed.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client or the event is already offered or not ET_EVENT type.
Disables an event by removing it from all added event groups.
NOTE: This API must be called before OfferEvent() if needed.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client or if the event is already offered.
Offers an event which is enabled for a server-service-instance.
NOTE: This API must be called after OfferService() and EnableEvent() if needed.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client or not offered, or the event is not enabled.
- LE_DUPLICATE – The event is already offered.
Stops offering an event for a server-service-instance.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client or not offered, or the event is not enabled.
- LE_DUPLICATE – The event is already stopped.
Fires an event or field notification. The specified event is updated with the specified payload Data. Dependent on the type of the event, the payload is distributed to all notified clients (always for events, only if the payload has changed for fields).
NOTE: This API is only available after offerService() and OfferEvent().
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid serviceRef.
- LE_NOT_PERMITTED – The service is not set up by the client or not offered, or the event is not enabled or not offered.
Add handler function for EVENT 'taf_someipSvr_RxMsg'
This event provides information on Rx message.
Remove handler function for EVENT 'taf_someipSvr_RxMsg'
Add handler function for EVENT 'taf_someipSvr_Subscription'
This event provides information on the event group subscription status.
Remove handler function for EVENT 'taf_someipSvr_Subscription'
Gets the service ID and Instance ID of the Rx Message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid msgRef.
Gets the method ID of the Rx message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid msgRef.
Gets the client ID of the Rx message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid msgRef.
Gets the message type of the Rx message. The possible message type can be MT_REQUEST(0x00) or MT_REQUEST_NO_RETURN(0x01).
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid msgRef.
Gets the payload size of the Rx message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid msgRef.
Gets the payload data of the Rx message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid msgRef.
Sends a response message for a Rx message. The Rx message is automatically freed after sending the response successfully.
NOTE: Only the message type MT_REQUEST(0x00) is allowed to send a response.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid msgRef.
- LE_NOT_PERMITTED – The msgRef is not a MT_REQUEST message, or the response message type is MT_ERROR(0x81) with returnCode E_OK(0x00), or the service of the msgRef is not set up by the client or not offered.
Releases a Rx message.
- Returns
- LE_OK – Succeeded.
- LE_BAD_PARAMETER – Invalid msgRef or invalid service of the msgRef.
- LE_NOT_PERMITTED – The service of the msgRef is not set up by the client.
Add handler function for EVENT 'taf_therm_TripEvent'
This event provides information on trip events.
Remove handler function for EVENT 'taf_therm_TripEvent'
Add handler function for EVENT 'taf_therm_CoolingLevelChangeEvent'
This event provides information on the change in cooling level of a cooling device.
Remove handler function for EVENT 'taf_therm_CoolingLevelChangeEvent'
Gets the list of available thermal zones.
- Returns
- NULL No thermal zone information found.
- taf_therm_ThermalZoneListRef The thermal zone list object reference.
Gets the list size of available thermal zones.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets the first thermal zone object reference in the list of the thermal zones retrieved with taf_therm_GetThermalZonesList().
- Returns
- NULL No thermal zone information found.
- taf_therm_ThermalZoneRef The thermal zone object reference.
Gets the next thermal zone object reference in the list of the thermal zones retrieved with taf_therm_GetThermalZonesList().
- Returns
- NULL No thermal zone information found.
- taf_therm_ThermalZoneRef The thermal zone object reference.
Gets the first trip point object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().
- Returns
- NULL No trip point information found.
- taf_therm_TripPointRef The trip point object reference.
Gets the next trip point object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().
- Returns
- NULL No trip point information found.
- taf_therm_TripPointRef The trip point object reference.
Gets the first bound cooling device object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().
- Returns
- NULL No bound cooling device information found.
- taf_therm_BoundCoolingDeviceRef The bound cooling device object reference.
Gets the next bound cooling device object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().
- Returns
- NULL No bound cooling device information found.
- taf_therm_BoundCoolingDeviceRef The bound cooling device object reference.
Retrieves a reference of the first trip point for the given bound cooling device.
- Returns
- NULL No bound trip point information found.
- taf_therm_TripPointRef The bound trip point object reference.
Retrieves a reference of the next trip point for the given bound cooling device.
- Returns
- NULL No bound trip point information found.
- taf_therm_TripPointRef The bound trip point object reference.
Retrieves the thermal zone ID for the given zone reference.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the thermal zone type.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the thermal zone current temperature.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the thermal zone passive temperature.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the trip point list size.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the bound cooling device list size.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the trip point type.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the trip point threshold.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the trip point hysteresis.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the trip point trip ID.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
- Note
- This is supported only on SA525M.
Retrieves the thermal zone ID associated with the given trip point.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
- Note
- This is supported only on SA525M.
Retrieves the bound cooling device's cooling ID.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the bound cooling device trip point list size.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the bound cooling device's trip point type.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the bound cooling device's trip point threshold.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the bound cooling device's trip point hysteresis.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the bound trip point trip ID.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
- Note
- This is supported only on SA525M.
Retrieves the thermal zone ID that the bound trip point is associated with.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
- Note
- This is supported only on SA525M.
Deletes the list of the thermal zones.
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_OK – Succeeded.
Gets the list of available cooling devices.
- Returns
- NULL No cooling device information found.
- taf_therm_CoolingDeviceListeRef The cooling device object reference.
Gets the list size of available cooling devices.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Gets the first cooling device object reference in the list of the cooling device retrieved with taf_therm_GetCoolingDeviceList().
- Returns
- NULL No cooling device information found.
- taf_therm_CoolingDeviceRef The cooling device object reference.
Gets the next cooling device object reference in the list of the cooling devices retrieved with taf_therm_GetCoolingDeviceList().
- Returns
- NULL No cooling device information found.
- taf_therm_CoolingDeviceRef The cooling device object reference.
Retrieves the cooling device's cooling ID.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the cooling device description.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the cooling device's maximum cooling level.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Retrieves the cooling device's current cooling level.
- Returns
- LE_FAULT Failed.
- LE_OK Succeeded.
Deletes the cooling device list retrieved with taf_therm_GetCoolingDeviceList().
- Returns
- LE_BAD_PARAMETER – Bad parameters.
- LE_OK – Succeeded.
Retrieves the thermal zone information of the given name.
- Returns
- NULL No thermal zone information found.
- taf_therm_ThermalZoneRef The thermal zone object reference.
Retrieves the information of the specific cooling device with the given name.
- Returns
- NULL No cooling device information found.
- taf_therm_CoolingDeviceRef The cooling device object reference.
Releases the trip event sample reference.
- Returns
- LE_BAD_PARAMETER Invalid reference passed.
- LE_OK Succeeded.
Releases the cooling device sample reference.
LE_BAD_PARAMETER Invalid reference passed.
Releases the thermal zone reference.
LE_BAD_PARAMETER Invalid reference passed.
Add handler function for EVENT 'taf_update_State'
Event to report update progress.
Remove handler function for EVENT 'taf_update_State'
Downloads an OTA package from a cloud server.
- Note
- Update service will parse the download package and remove the QOTA header once the download is complete.
Installs an OTA package on the target device.
- Note
- QOTA header should be removed before calling this API.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets download session.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Starts download.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Pauses download.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Resumes download.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Cancels download.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets installation session.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Checks prerequisites for installation.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Start installation.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Verification post installation, check if flashing properly on inactive bank.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Gets the active bank.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Activation verification, check if each component has the updated version.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Rollback to previous configurations to keep pesistency.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Bank synchronization.
- Returns
- LE_FAULT – Failed.
- LE_OK – Succeeded.
Add handler function for EVENT 'taf_voicecall_State'
Remove handler function for EVENT 'taf_voicecall_State'
Starts a call according to a given phone number and slot ID.
- Returns
- Reference to the voice call.
- NULL if the voice call can not be processed.
Stops a call according to the given reference ID.
- Returns
- LE_OK – Succeeded.
- Others – Failed.
Deletes a call according to the given call reference.
- Returns
- LE_OK – Succeeded.
- Others – Failed.
Answers an incoming or a waiting call. The call reference can be retrieved from the call state handler.If a Waiting call is being answered and the existing call is Active, then the existing call will move to Hold state. If the existing call is on Hold already, then it will remain on Hold. The waiting call state transitions from Waiting to Active. If a Waiting call is being answered and the existing call is Active, then the existing call will move to Hold state. If the existing call is on Hold already, then it will remain on Hold. The waiting call state transitions from Waiting to Active.
- Returns
- LE_OK – Succeeded.
- Others – Failed.
Gets the call end reason according to the call reference. This call should be in the END state. The call should be in the idle state when calling this API.
- Returns
- LE_OK – Succeeded.
- Others – Failed.
Holds the active call. This call should be in the ACTIVE state.
- Returns
- LE_OK – Succeeded.
- Others – Failed.
Resumes the holding call. This call should be in the HOLD state.
- Returns
- LE_OK – Succeeded.
- Others – Failed.
Swaps calls to make one active and put the another on hold. This should be two calls, where one is in the holding state and the another is in the active state.
- Returns
- LE_OK – Succeeded.
- Others – Failed.