le_atServer_interface.h
Go to the documentation of this file.
18 * server is compliant with 3GPP 27.007, paragraphs 4.0, 4.1 and 4.2, and V25 ter, paragraphs 5.3,39 * Lowercase characters are changed to their uppercase equivalents. Only characters between quotes63 * All characters after the "D" are considered part of The D command parameter up to a semicolon or91 * Extended syntax command can be concatenated after basic syntax commands without a separator:<br>96 * le_atServer_Open() must be called to bind the file descriptor of the device with the AT commands110 * A new AT command can be added into the parser using le_atServer_Create(), and it can be deleted137 * Even if these types are specific to the extended format commands according to the standards, they142 * parameter value using le_atServer_GetParameter() API. If a parmeter is not parsed with quotes,147 * The AT command handling mechanism may rely on an intermediate handler to reroute the AT commands149 * le_atServer_AddCmdRegistrationHandler() installs such a registration handler that will be called159 * @note If le_atServer_SendIntermediateResponse() return LE_FAULT, the final response have to be170 * le_atServer_SendFinalResultCode() takes as arguments the AT command reference, a pattern (which175 * concatenated commands: if one command is failed, next commands are not executed, the final result180 * @deprecated le_atServer_SendFinalResponse() should not be used anymore and will be removed soon.184 * le_atServer_SendFinalResponse(). The corresponding device will be locked until the final response193 * - continue or stop the parsing of concatenated commands: if one command is failed, next commands204 * If an unsolicited response is sent when an AT command is in progress, the unsolicited response210 * le_atServer_EnableExtendedErrorCodes() allows the user to use extended error codes on a selected212 * le_atServer_EnableVerboseErrorCodes() allows the user to enable verbose error codes on a selected214 * le_atServer_DisableExtendedErrorCodes() allows the user to disable the current error mode namely224 * le_atServer_CreateErrorCode() returns a reference which can be used to attach a custom verbose230 * le_atServer_GetTextAsync() allows the user to register a le_atServer_GetTextCallback_t callback256 * all unknown AT commands to an alternative device (such as the modem). For all devices linked to271 * (e.g.; ATD*99***1#). Sending these commands through the bridge may lock the Legato AT commands282 * @warning Some modem AT commands may conflict with Legato APIs; using both may cause problems that286 * The application can send an unsolicited on all opened device, or only one on a dedicated device.310 //--------------------------------------------------------------------------------------------------314 //--------------------------------------------------------------------------------------------------317 //--------------------------------------------------------------------------------------------------320 * Connect the current client thread to the service providing this API. Block until the service is323 * For each thread that wants to use this API, either ConnectService or TryConnectService must be324 * called before any other functions in this API. Normally, ConnectService is automatically called329 //--------------------------------------------------------------------------------------------------335 //--------------------------------------------------------------------------------------------------338 * Try to connect the current client thread to the service providing this API. Return with an error341 * For each thread that wants to use this API, either ConnectService or TryConnectService must be342 * called before any other functions in this API. Normally, ConnectService is automatically called351 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).354 //--------------------------------------------------------------------------------------------------360 //--------------------------------------------------------------------------------------------------364 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants367 //--------------------------------------------------------------------------------------------------374 //--------------------------------------------------------------------------------------------------380 * longer a connection to the service, and the functions in this API can't be used. For details, see385 //--------------------------------------------------------------------------------------------------392 //--------------------------------------------------------------------------------------------------396 //--------------------------------------------------------------------------------------------------399 //--------------------------------------------------------------------------------------------------403 //--------------------------------------------------------------------------------------------------406 //--------------------------------------------------------------------------------------------------410 //--------------------------------------------------------------------------------------------------413 //--------------------------------------------------------------------------------------------------417 //--------------------------------------------------------------------------------------------------420 //--------------------------------------------------------------------------------------------------425 //--------------------------------------------------------------------------------------------------428 //--------------------------------------------------------------------------------------------------432 //--------------------------------------------------------------------------------------------------435 //--------------------------------------------------------------------------------------------------439 //--------------------------------------------------------------------------------------------------442 //--------------------------------------------------------------------------------------------------447 //--------------------------------------------------------------------------------------------------450 //--------------------------------------------------------------------------------------------------454 //--------------------------------------------------------------------------------------------------457 //--------------------------------------------------------------------------------------------------464 //--------------------------------------------------------------------------------------------------467 //--------------------------------------------------------------------------------------------------471 //--------------------------------------------------------------------------------------------------474 //--------------------------------------------------------------------------------------------------484 //--------------------------------------------------------------------------------------------------487 //--------------------------------------------------------------------------------------------------500 //--------------------------------------------------------------------------------------------------507 //--------------------------------------------------------------------------------------------------520 //--------------------------------------------------------------------------------------------------527 //--------------------------------------------------------------------------------------------------539 //--------------------------------------------------------------------------------------------------546 //--------------------------------------------------------------------------------------------------557 //--------------------------------------------------------------------------------------------------564 //--------------------------------------------------------------------------------------------------572 //--------------------------------------------------------------------------------------------------579 //--------------------------------------------------------------------------------------------------589 //--------------------------------------------------------------------------------------------------596 //--------------------------------------------------------------------------------------------------603 //--------------------------------------------------------------------------------------------------613 //--------------------------------------------------------------------------------------------------617 //--------------------------------------------------------------------------------------------------624 //--------------------------------------------------------------------------------------------------631 //--------------------------------------------------------------------------------------------------642 //--------------------------------------------------------------------------------------------------646 //--------------------------------------------------------------------------------------------------653 //--------------------------------------------------------------------------------------------------666 //--------------------------------------------------------------------------------------------------679 //--------------------------------------------------------------------------------------------------688 //--------------------------------------------------------------------------------------------------699 //--------------------------------------------------------------------------------------------------709 //--------------------------------------------------------------------------------------------------718 //--------------------------------------------------------------------------------------------------727 //--------------------------------------------------------------------------------------------------737 //--------------------------------------------------------------------------------------------------741 * @deprecated le_atServer_SendFinalResponse() should not be used anymore and will be removed soon.749 //--------------------------------------------------------------------------------------------------763 //--------------------------------------------------------------------------------------------------772 //--------------------------------------------------------------------------------------------------785 //--------------------------------------------------------------------------------------------------794 //--------------------------------------------------------------------------------------------------809 //--------------------------------------------------------------------------------------------------817 //--------------------------------------------------------------------------------------------------824 //--------------------------------------------------------------------------------------------------832 //--------------------------------------------------------------------------------------------------839 //--------------------------------------------------------------------------------------------------842 * All unknown AT commands will be sent on this alternative file descriptor thanks to the AT client849 //--------------------------------------------------------------------------------------------------856 //--------------------------------------------------------------------------------------------------865 //--------------------------------------------------------------------------------------------------872 //--------------------------------------------------------------------------------------------------881 //--------------------------------------------------------------------------------------------------890 //--------------------------------------------------------------------------------------------------900 //--------------------------------------------------------------------------------------------------909 //--------------------------------------------------------------------------------------------------913 //--------------------------------------------------------------------------------------------------919 //--------------------------------------------------------------------------------------------------923 //--------------------------------------------------------------------------------------------------929 //--------------------------------------------------------------------------------------------------933 //--------------------------------------------------------------------------------------------------939 //--------------------------------------------------------------------------------------------------950 //--------------------------------------------------------------------------------------------------959 //--------------------------------------------------------------------------------------------------967 //--------------------------------------------------------------------------------------------------974 //--------------------------------------------------------------------------------------------------982 //--------------------------------------------------------------------------------------------------991 //--------------------------------------------------------------------------------------------------1001 //--------------------------------------------------------------------------------------------------le_result_t le_atServer_Close(le_atServer_DeviceRef_t device)void(* le_atServer_DisconnectHandler_t)(void *)Definition: le_atServer_interface.h:315le_result_t le_atServer_TryConnectService(void)le_result_t le_atServer_RemoveDeviceFromBridge(le_atServer_DeviceRef_t deviceRef, le_atServer_BridgeRef_t bridgeRef)void le_atServer_EnableExtendedErrorCodes(void)le_result_t le_atServer_GetParameter(le_atServer_CmdRef_t commandRef, uint32_t index, char *parameter, size_t parameterSize)le_result_t le_atServer_GetCommandName(le_atServer_CmdRef_t commandRef, char *name, size_t nameSize)le_atServer_CmdRegistrationHandlerRef_t le_atServer_AddCmdRegistrationHandler(le_atServer_CmdRegistrationHandlerFunc_t handlerPtr, void *contextPtr)le_result_t le_atServer_GetDevice(le_atServer_CmdRef_t commandRef, le_atServer_DeviceRef_t *deviceRefPtr)le_result_t le_atServer_SetVerboseErrorCode(le_atServer_ErrorCodeRef_t errorCodeRef, const char *LE_NONNULL verboseCode)le_result_t le_atServer_EnableEcho(le_atServer_DeviceRef_t device)le_atServer_CommandHandlerRef_t le_atServer_AddCommandHandler(le_atServer_CmdRef_t commandRef, le_atServer_CommandHandlerFunc_t handlerPtr, void *contextPtr)le_atServer_DeviceRef_t le_atServer_Open(int fd)le_atServer_CmdRef_t le_atServer_Create(const char *LE_NONNULL name)void le_atServer_ConnectService(void)le_result_t le_atServer_AddDeviceToBridge(le_atServer_DeviceRef_t deviceRef, le_atServer_BridgeRef_t bridgeRef)le_result_t le_atServer_Resume(le_atServer_DeviceRef_t device)le_result_t le_atServer_Delete(le_atServer_CmdRef_t commandRef)le_result_t le_atServer_CloseBridge(le_atServer_BridgeRef_t bridgeRef)LE_FULL_API void le_atServer_SetServerDisconnectHandler(le_atServer_DisconnectHandler_t disconnectHandler, void *contextPtr)le_result_t le_atServer_SendFinalResponse(le_atServer_CmdRef_t commandRef, le_atServer_FinalRsp_t finalResponse, bool customStringAvailable, const char *LE_NONNULL finalRsp)void le_atServer_EnableVerboseErrorCodes(void)void le_atServer_RemoveCommandHandler(le_atServer_CommandHandlerRef_t handlerRef)le_result_t le_atServer_Suspend(le_atServer_DeviceRef_t device)le_result_t le_atServer_GetTextAsync(le_atServer_CmdRef_t cmdRef, le_atServer_GetTextCallbackFunc_t callbackPtr, void *contextPtr)void le_atServer_RemoveCmdRegistrationHandler(le_atServer_CmdRegistrationHandlerRef_t handlerRef)void le_atServer_DisableExtendedErrorCodes(void)le_result_t le_atServer_SendIntermediateResponse(le_atServer_CmdRef_t commandRef, const char *LE_NONNULL intermediateRsp)le_atServer_ErrorCodeRef_t le_atServer_CreateErrorCode(uint32_t errorCode, const char *LE_NONNULL pattern)void le_atServer_DisconnectService(void)le_result_t le_atServer_SendUnsolicitedResponse(const char *LE_NONNULL unsolRsp, le_atServer_AvailableDevice_t availableDevice, le_atServer_DeviceRef_t device)le_result_t le_atServer_DisableEcho(le_atServer_DeviceRef_t device)le_result_t le_atServer_SendFinalResultCode(le_atServer_CmdRef_t commandRef, le_atServer_FinalRsp_t finalResult, const char *LE_NONNULL pattern, uint32_t errorCode)le_atServer_BridgeRef_t le_atServer_OpenBridge(int fd)le_result_t le_atServer_DeleteErrorCode(le_atServer_ErrorCodeRef_t errorCodeRef)