le_atServer_interface.h
Go to the documentation of this file.
16 * server is compliant with 3GPP 27.007, paragraphs 4.0, 4.1 and 4.2, and V25 ter, paragraphs 5.3,25 * Lowercase characters are changed to their uppercase equivalents. Only characters between quotes61 * Extended syntax command can be concatenated after basic syntax commands without a separator:<br>66 * le_atServer_Start() must be called to bind the file descriptor of the device with the AT commands80 * A new AT command can be added into the parser using le_atServer_Create(), and it can be deleted88 * le_atServer_AddCommandHandler(). It can be removed with le_atServer_RemoveCommandHandler().<br>94 * - In case of a basic format command, if exists, the parameter can be retrieved at the index 0.<br>103 * Even if these types are specific to the extended format commands according to the standards, they117 * le_atServer_SendFinalResponse(). The corresponding device will be locked until the final response126 * - continue or stop the parsing of concatenated commands: if one command is failed, next commands135 * response is sent between the latest final response and the next reception of an AT command).<br>136 * If an unsolicited response is sent when an AT command is in progress, the unsolicited response140 * The application can send an unsolicited on all opened device, or only one on a dedicated deivce.164 //--------------------------------------------------------------------------------------------------167 * Connect the current client thread to the service providing this API. Block until the service is170 * For each thread that wants to use this API, either ConnectService or TryConnectService must be171 * called before any other functions in this API. Normally, ConnectService is automatically called176 //--------------------------------------------------------------------------------------------------182 //--------------------------------------------------------------------------------------------------185 * Try to connect the current client thread to the service providing this API. Return with an error188 * For each thread that wants to use this API, either ConnectService or TryConnectService must be189 * called before any other functions in this API. Normally, ConnectService is automatically called196 * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.197 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).200 //--------------------------------------------------------------------------------------------------206 //--------------------------------------------------------------------------------------------------212 * longer a connection to the service, and the functions in this API can't be used. For details, see217 //--------------------------------------------------------------------------------------------------224 //--------------------------------------------------------------------------------------------------228 //--------------------------------------------------------------------------------------------------232 //--------------------------------------------------------------------------------------------------236 //--------------------------------------------------------------------------------------------------240 //--------------------------------------------------------------------------------------------------245 //--------------------------------------------------------------------------------------------------263 //--------------------------------------------------------------------------------------------------267 //--------------------------------------------------------------------------------------------------281 //--------------------------------------------------------------------------------------------------285 //--------------------------------------------------------------------------------------------------297 //--------------------------------------------------------------------------------------------------301 //--------------------------------------------------------------------------------------------------305 //--------------------------------------------------------------------------------------------------320 //--------------------------------------------------------------------------------------------------322 (329 //--------------------------------------------------------------------------------------------------342 //--------------------------------------------------------------------------------------------------349 //--------------------------------------------------------------------------------------------------362 //--------------------------------------------------------------------------------------------------369 //--------------------------------------------------------------------------------------------------381 //--------------------------------------------------------------------------------------------------388 //--------------------------------------------------------------------------------------------------399 //--------------------------------------------------------------------------------------------------406 //--------------------------------------------------------------------------------------------------414 //--------------------------------------------------------------------------------------------------421 //--------------------------------------------------------------------------------------------------431 //--------------------------------------------------------------------------------------------------438 //--------------------------------------------------------------------------------------------------449 //--------------------------------------------------------------------------------------------------462 //--------------------------------------------------------------------------------------------------468 //--------------------------------------------------------------------------------------------------481 //--------------------------------------------------------------------------------------------------485 //--------------------------------------------------------------------------------------------------492 //--------------------------------------------------------------------------------------------------501 //--------------------------------------------------------------------------------------------------517 //--------------------------------------------------------------------------------------------------526 //--------------------------------------------------------------------------------------------------539 //--------------------------------------------------------------------------------------------------548 //--------------------------------------------------------------------------------------------------558 //--------------------------------------------------------------------------------------------------567 //--------------------------------------------------------------------------------------------------584 //--------------------------------------------------------------------------------------------------593 //--------------------------------------------------------------------------------------------------Definition: le_atServer_interface.h:270void(* le_atServer_CommandHandlerFunc_t)(le_atServer_CmdRef_t commandRef, le_atServer_Type_t type, uint32_t parametersNumber, void *contextPtr)Definition: le_atServer_interface.h:322le_result_t le_atServer_SendIntermediateResponse(le_atServer_CmdRef_t commandRef, const char *intermediateRsp)action will be done on all bound devicesDefinition: le_atServer_interface.h:288Action AT command (e.g. 'AT+CMD')Definition: le_atServer_interface.h:248struct le_atServer_Device * le_atServer_DeviceRef_tDefinition: le_atServer_interface.h:237action will be done on a specified deviceDefinition: le_atServer_interface.h:291void le_atServer_RemoveCommandHandler(le_atServer_CommandHandlerRef_t addHandlerRef)le_atServer_DeviceRef_t le_atServer_Open(int fd)le_result_t le_atServer_SendFinalResponse(le_atServer_CmdRef_t commandRef, le_atServer_FinalRsp_t final, bool customStringAvailable, const char *finalRsp)le_result_t le_atServer_Close(le_atServer_DeviceRef_t device)le_result_t le_atServer_Delete(le_atServer_CmdRef_t commandRef)le_atServer_CommandHandlerRef_t le_atServer_AddCommandHandler(le_atServer_CmdRef_t commandRef, le_atServer_CommandHandlerFunc_t handlerPtr, void *contextPtr)void le_atServer_DisconnectService(void)AT command received with parameters (e.g. 'AT+CMD=x,y')Definition: le_atServer_interface.h:251le_result_t le_atServer_SendUnsolicitedResponse(const char *unsolRsp, le_atServer_AvailableDevice_t availableDevice, le_atServer_DeviceRef_t device)void le_atServer_ConnectService(void)Test AT command (e.g. 'AT+CMD=?')Definition: le_atServer_interface.h:254struct le_atServer_CommandHandler * le_atServer_CommandHandlerRef_tDefinition: le_atServer_interface.h:302Definition: le_atServer_interface.h:274le_atServer_CmdRef_t le_atServer_Create(const char *name)le_result_t le_atServer_TryConnectService(void)le_result_t le_atServer_Suspend(le_atServer_DeviceRef_t device)le_result_t le_atServer_SetDevice(le_atServer_CmdRef_t commandRef, le_atServer_AvailableDevice_t availableDevice, le_atServer_DeviceRef_t device)le_result_t le_atServer_GetCommandName(le_atServer_CmdRef_t commandRef, char *name, size_t nameNumElements)struct le_atServer_Cmd * le_atServer_CmdRef_tDefinition: le_atServer_interface.h:229le_result_t le_atServer_GetParameter(le_atServer_CmdRef_t commandRef, uint32_t index, char *parameter, size_t parameterNumElements)le_result_t le_atServer_Resume(le_atServer_DeviceRef_t device)Read AT command (e.g. 'AT+CMD?')Definition: le_atServer_interface.h:257