le_atServer_common.h

    1 
    2 /*
    3  * ====================== WARNING ======================
    4  *
    5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    6  * DO NOT MODIFY IN ANY WAY.
    7  *
    8  * ====================== WARNING ======================
    9  */
   10 /**
   11  * @file le_atServer_common.h
   12  *
   13  * Type definitions for le_atServer.
   14  *
   15  */
   16 #ifndef LE_ATSERVER_COMMON_H_INCLUDE_GUARD
   17 #define LE_ATSERVER_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 // Interface specific includes
   23 #include "le_atDefs_common.h"
   24 
   25 #define IFGEN_LE_ATSERVER_PROTOCOL_ID "19a1238badbd041a2f671e29fe9225fe"
   26 #define IFGEN_LE_ATSERVER_MSG_SIZE 4119
   27 /** @addtogroup le_atServer
   28  *  @{ **/
   29 
   30 
   31 //--------------------------------------------------------------------------------------------------
   32 /**
   33  *  Maximum text length.
   34  */
   35 //--------------------------------------------------------------------------------------------------
   36 #define LE_ATSERVER_TEXT_MAX_LEN 4096
   37 
   38 //--------------------------------------------------------------------------------------------------
   39 /**
   40  *  CME error pattern
   41  */
   42 //--------------------------------------------------------------------------------------------------
   43 #define LE_ATSERVER_CME_ERROR "+CME ERROR: "
   44 
   45 //--------------------------------------------------------------------------------------------------
   46 /**
   47  *  CMS error pattern
   48  */
   49 //--------------------------------------------------------------------------------------------------
   50 #define LE_ATSERVER_CMS_ERROR "+CMS ERROR: "
   51 
   52 //--------------------------------------------------------------------------------------------------
   53 /**
   54  *  Reference type for an AT command.
   55  */
   56 //--------------------------------------------------------------------------------------------------
   57 typedef struct le_atServer_Cmd* le_atServer_CmdRef_t;
   58 
   59 
   60 //--------------------------------------------------------------------------------------------------
   61 /**
   62  *  Reference type for a AT command device.
   63  */
   64 //--------------------------------------------------------------------------------------------------
   65 typedef struct le_atServer_Device* le_atServer_DeviceRef_t;
   66 
   67 
   68 //--------------------------------------------------------------------------------------------------
   69 /**
   70  *  Reference type for a AT commands server / AT commands client bridge.
   71  */
   72 //--------------------------------------------------------------------------------------------------
   73 typedef struct le_atServer_Bridge* le_atServer_BridgeRef_t;
   74 
   75 
   76 //--------------------------------------------------------------------------------------------------
   77 /**
   78  *  Reference type for an error code.
   79  */
   80 //--------------------------------------------------------------------------------------------------
   81 typedef struct le_atServer_ErrorCode* le_atServer_ErrorCodeRef_t;
   82 
   83 
   84 //--------------------------------------------------------------------------------------------------
   85 /**
   86  * Received AT command type.
   87  *
   88  */
   89 //--------------------------------------------------------------------------------------------------
   90 typedef enum
   91 {
   92     LE_ATSERVER_TYPE_ACT = 0,
   93         ///< Action AT command (e.g. 'AT+CMD')
   94     LE_ATSERVER_TYPE_PARA = 1,
   95         ///< AT command received with parameters (e.g. 'AT+CMD=x,y')
   96     LE_ATSERVER_TYPE_TEST = 2,
   97         ///< Test AT command (e.g. 'AT+CMD=?')
   98     LE_ATSERVER_TYPE_READ = 3
   99         ///< Read AT command (e.g. 'AT+CMD?')
  100 }
  101 le_atServer_Type_t;
  102 
  103 
  104 //--------------------------------------------------------------------------------------------------
  105 /**
  106  * Final response.
  107  */
  108 //--------------------------------------------------------------------------------------------------
  109 typedef enum
  110 {
  111     LE_ATSERVER_OK = 0,
  112         ///< AT command successfully treated
  113     LE_ATSERVER_NO_CARRIER = 1,
  114         ///< Connection terminated
  115     LE_ATSERVER_ERROR = 2,
  116         ///< Error in AT command treatement
  117     LE_ATSERVER_NO_DIALTONE = 3,
  118         ///< No dialtone detected
  119     LE_ATSERVER_BUSY = 4
  120         ///< Busy signal detected
  121 }
  122 le_atServer_FinalRsp_t;
  123 
  124 
  125 //--------------------------------------------------------------------------------------------------
  126 /**
  127  * Device availability.
  128  */
  129 //--------------------------------------------------------------------------------------------------
  130 typedef enum
  131 {
  132     LE_ATSERVER_ALL_DEVICES = 0,
  133         ///< action will be done on all bound devices
  134     LE_ATSERVER_SPECIFIC_DEVICE = 1
  135         ///< action will be done on a specified device
  136 }
  137 le_atServer_AvailableDevice_t;
  138 
  139 
  140 //--------------------------------------------------------------------------------------------------
  141 /**
  142  * Reference type used by Add/Remove functions for EVENT 'le_atServer_CmdRegistration'
  143  */
  144 //--------------------------------------------------------------------------------------------------
  145 typedef struct le_atServer_CmdRegistrationHandler* le_atServer_CmdRegistrationHandlerRef_t;
  146 
  147 
  148 //--------------------------------------------------------------------------------------------------
  149 /**
  150  * Reference type used by Add/Remove functions for EVENT 'le_atServer_Command'
  151  */
  152 //--------------------------------------------------------------------------------------------------
  153 typedef struct le_atServer_CommandHandler* le_atServer_CommandHandlerRef_t;
  154 
  155 
  156 //--------------------------------------------------------------------------------------------------
  157 /**
  158  * Handler for platform-specific command registration.
  159  *
  160  */
  161 //--------------------------------------------------------------------------------------------------
  162 typedef void (*le_atServer_CmdRegistrationHandlerFunc_t)
  163 (
  164         le_atServer_CmdRef_t commandRef,
  165         ///< AT command reference
  166         void* contextPtr
  167         ///<
  168 );
  169 
  170 //--------------------------------------------------------------------------------------------------
  171 /**
  172  * Handler for the AT command processing.
  173  *
  174  * @note The argument "parametersNumber" is set only when "type" parameter value is
  175  * LE_AT_SERVER_TYPE_PARA
  176  */
  177 //--------------------------------------------------------------------------------------------------
  178 typedef void (*le_atServer_CommandHandlerFunc_t)
  179 (
  180         le_atServer_CmdRef_t commandRef,
  181         ///< Received AT command reference
  182         le_atServer_Type_t type,
  183         ///< Received AT command type
  184         uint32_t parametersNumber,
  185         ///< Parameters number
  186         void* contextPtr
  187         ///<
  188 );
  189 
  190 //--------------------------------------------------------------------------------------------------
  191 /**
  192  * Get text callback
  193  *
  194  * @return
  195  *      - LE_OK: The function succeeded
  196  *      - LE_IO_ERROR: An io error happened and the function couldn't read from the device
  197  *      - LE_FORMAT_ERROR: Received an invalid character or an invalid sequence
  198  *      - LE_FAULT: Failed to remove backspaces
  199  */
  200 //--------------------------------------------------------------------------------------------------
  201 typedef void (*le_atServer_GetTextCallbackFunc_t)
  202 (
  203         le_atServer_CmdRef_t cmdRef,
  204         ///< Received AT command reference
  205         le_result_t result,
  206         ///< Result
  207         const char* LE_NONNULL text,
  208         ///< Received text
  209         uint32_t len,
  210         ///< Text length
  211         void* contextPtr
  212         ///<
  213 );
  214 
  215 
  216 //--------------------------------------------------------------------------------------------------
  217 /**
  218  * Get if this client bound locally.
  219  */
  220 //--------------------------------------------------------------------------------------------------
  221 LE_SHARED bool ifgen_le_atServer_HasLocalBinding
  222 (
  223     void
  224 );
  225 
  226 
  227 //--------------------------------------------------------------------------------------------------
  228 /**
  229  * Init data that is common across all threads
  230  */
  231 //--------------------------------------------------------------------------------------------------
  232 LE_SHARED void ifgen_le_atServer_InitCommonData
  233 (
  234     void
  235 );
  236 
  237 
  238 //--------------------------------------------------------------------------------------------------
  239 /**
  240  * Perform common initialization and open a session
  241  */
  242 //--------------------------------------------------------------------------------------------------
  243 LE_SHARED le_result_t ifgen_le_atServer_OpenSession
  244 (
  245     le_msg_SessionRef_t _ifgen_sessionRef,
  246     bool isBlocking
  247 );
  248 
  249 //--------------------------------------------------------------------------------------------------
  250 /**
  251  * Suspend server / enter data mode
  252  *
  253  * When this function is called the server stops monitoring the fd for events
  254  * hence no more I/O operations are done on the fd by the server.
  255  *
  256  * @return
  257  *      - LE_OK             Success.
  258  *      - LE_BAD_PARAMETER  Invalid device reference.
  259  *      - LE_FAULT          Device not monitored
  260  *
  261  */
  262 //--------------------------------------------------------------------------------------------------
  263 LE_SHARED le_result_t ifgen_le_atServer_Suspend
  264 (
  265     le_msg_SessionRef_t _ifgen_sessionRef,
  266         le_atServer_DeviceRef_t device
  267         ///< [IN] device to be suspended
  268 );
  269 
  270 //--------------------------------------------------------------------------------------------------
  271 /**
  272  * Resume server / enter command mode
  273  *
  274  * When this function is called the server resumes monitoring the fd for events
  275  * and is able to interpret AT commands again.
  276  *
  277  * @return
  278  *      - LE_OK             Success.
  279  *      - LE_BAD_PARAMETER  Invalid device reference.
  280  *      - LE_FAULT          Device not monitored
  281  *
  282  */
  283 //--------------------------------------------------------------------------------------------------
  284 LE_SHARED le_result_t ifgen_le_atServer_Resume
  285 (
  286     le_msg_SessionRef_t _ifgen_sessionRef,
  287         le_atServer_DeviceRef_t device
  288         ///< [IN] device to be resumed
  289 );
  290 
  291 //--------------------------------------------------------------------------------------------------
  292 /**
  293  * This function opens an AT server session on the requested device.
  294  *
  295  * @return
  296  *      - Reference to the requested device.
  297  *      - NULL if the device is not available or fd is a BAD FILE DESCRIPTOR.
  298  *
  299  * @note Make sure to duplicate (man dup) your file descriptor before opening
  300  *       a server session to be able to use the suspend/resume feature
  301  *
  302  */
  303 //--------------------------------------------------------------------------------------------------
  304 LE_SHARED le_atServer_DeviceRef_t ifgen_le_atServer_Open
  305 (
  306     le_msg_SessionRef_t _ifgen_sessionRef,
  307         int fd
  308         ///< [IN] File descriptor.
  309 );
  310 
  311 //--------------------------------------------------------------------------------------------------
  312 /**
  313  * This function closes the AT server session on the requested device.
  314  *
  315  * @return
  316  *      - LE_OK             The function succeeded.
  317  *      - LE_BAD_PARAMETER  Invalid device reference.
  318  *      - LE_BUSY           The requested device is busy.
  319  *      - LE_FAULT          Failed to stop the server, check logs
  320  *                              for more information.
  321  */
  322 //--------------------------------------------------------------------------------------------------
  323 LE_SHARED le_result_t ifgen_le_atServer_Close
  324 (
  325     le_msg_SessionRef_t _ifgen_sessionRef,
  326         le_atServer_DeviceRef_t device
  327         ///< [IN] device to be unbound
  328 );
  329 
  330 //--------------------------------------------------------------------------------------------------
  331 /**
  332  * This function created an AT command and register it into the AT parser.
  333  *
  334  * @return
  335  *      - Reference to the AT command.
  336  *      - NULL if an error occurs.
  337  */
  338 //--------------------------------------------------------------------------------------------------
  339 LE_SHARED le_atServer_CmdRef_t ifgen_le_atServer_Create
  340 (
  341     le_msg_SessionRef_t _ifgen_sessionRef,
  342         const char* LE_NONNULL name
  343         ///< [IN] AT command name string
  344 );
  345 
  346 //--------------------------------------------------------------------------------------------------
  347 /**
  348  * This function deletes an AT command (i.e. unregister from the AT parser).
  349  *
  350  * @return
  351  *      - LE_OK            The function succeeded.
  352  *      - LE_FAULT         The function failed to delete the command.
  353  *      - LE_BUSY          Command is in progress.
  354  *
  355  */
  356 //--------------------------------------------------------------------------------------------------
  357 LE_SHARED le_result_t ifgen_le_atServer_Delete
  358 (
  359     le_msg_SessionRef_t _ifgen_sessionRef,
  360         le_atServer_CmdRef_t commandRef
  361         ///< [IN] AT command reference
  362 );
  363 
  364 //--------------------------------------------------------------------------------------------------
  365 /**
  366  * Add handler function for EVENT 'le_atServer_CmdRegistration'
  367  *
  368  * This event provides information when a new AT command is subscribed.
  369  *
  370  */
  371 //--------------------------------------------------------------------------------------------------
  372 LE_SHARED le_atServer_CmdRegistrationHandlerRef_t ifgen_le_atServer_AddCmdRegistrationHandler
  373 (
  374     le_msg_SessionRef_t _ifgen_sessionRef,
  375         le_atServer_CmdRegistrationHandlerFunc_t handlerPtr,
  376         ///< [IN] Handler to called when a new AT command
  377         ///< is subscribed
  378         void* contextPtr
  379         ///< [IN]
  380 );
  381 
  382 //--------------------------------------------------------------------------------------------------
  383 /**
  384  * Remove handler function for EVENT 'le_atServer_CmdRegistration'
  385  */
  386 //--------------------------------------------------------------------------------------------------
  387 LE_SHARED void ifgen_le_atServer_RemoveCmdRegistrationHandler
  388 (
  389     le_msg_SessionRef_t _ifgen_sessionRef,
  390         le_atServer_CmdRegistrationHandlerRef_t handlerRef
  391         ///< [IN]
  392 );
  393 
  394 //--------------------------------------------------------------------------------------------------
  395 /**
  396  * Add handler function for EVENT 'le_atServer_Command'
  397  *
  398  * This event provides information when the AT command is detected.
  399  *
  400  */
  401 //--------------------------------------------------------------------------------------------------
  402 LE_SHARED le_atServer_CommandHandlerRef_t ifgen_le_atServer_AddCommandHandler
  403 (
  404     le_msg_SessionRef_t _ifgen_sessionRef,
  405         le_atServer_CmdRef_t commandRef,
  406         ///< [IN] AT command reference
  407         le_atServer_CommandHandlerFunc_t handlerPtr,
  408         ///< [IN] Handler to called when the AT command is detected
  409         void* contextPtr
  410         ///< [IN]
  411 );
  412 
  413 //--------------------------------------------------------------------------------------------------
  414 /**
  415  * Remove handler function for EVENT 'le_atServer_Command'
  416  */
  417 //--------------------------------------------------------------------------------------------------
  418 LE_SHARED void ifgen_le_atServer_RemoveCommandHandler
  419 (
  420     le_msg_SessionRef_t _ifgen_sessionRef,
  421         le_atServer_CommandHandlerRef_t handlerRef
  422         ///< [IN]
  423 );
  424 
  425 //--------------------------------------------------------------------------------------------------
  426 /**
  427  * This function can be used to get the parameters of a received AT command.
  428  *
  429  * @return
  430  *      - LE_OK            The function succeeded.
  431  *      - LE_FAULT         The function failed to get the requested parameter.
  432  *
  433  * @note If the parameter is parsed with quotes, the quotes are removed when retrieving the
  434  * parameter value using this API. If a parmeter is not parsed with quotes, that parameter is
  435  * converted to uppercase equivalent.
  436  *
  437  */
  438 //--------------------------------------------------------------------------------------------------
  439 LE_SHARED le_result_t ifgen_le_atServer_GetParameter
  440 (
  441     le_msg_SessionRef_t _ifgen_sessionRef,
  442         le_atServer_CmdRef_t commandRef,
  443         ///< [IN] AT command reference
  444         uint32_t index,
  445         ///< [IN] agument index
  446         char* parameter,
  447         ///< [OUT] parameter value
  448         size_t parameterSize
  449         ///< [IN]
  450 );
  451 
  452 //--------------------------------------------------------------------------------------------------
  453 /**
  454  * This function can be used to get the AT command string.
  455  *
  456  * @return
  457  *      - LE_OK            The function succeeded.
  458  *      - LE_FAULT         The function failed to get the AT command string.
  459  *
  460  */
  461 //--------------------------------------------------------------------------------------------------
  462 LE_SHARED le_result_t ifgen_le_atServer_GetCommandName
  463 (
  464     le_msg_SessionRef_t _ifgen_sessionRef,
  465         le_atServer_CmdRef_t commandRef,
  466         ///< [IN] AT command reference
  467         char* name,
  468         ///< [OUT] AT command string
  469         size_t nameSize
  470         ///< [IN]
  471 );
  472 
  473 //--------------------------------------------------------------------------------------------------
  474 /**
  475  * This function can be used to get the device reference in use for an AT command specified with
  476  * its reference.
  477  *
  478  * @return
  479  *      - LE_OK            The function succeeded.
  480  *      - LE_FAULT         The function failed to get the AT command string.
  481  *
  482  */
  483 //--------------------------------------------------------------------------------------------------
  484 LE_SHARED le_result_t ifgen_le_atServer_GetDevice
  485 (
  486     le_msg_SessionRef_t _ifgen_sessionRef,
  487         le_atServer_CmdRef_t commandRef,
  488         ///< [IN] AT command reference
  489         le_atServer_DeviceRef_t* deviceRefPtr
  490         ///< [OUT] Device reference
  491 );
  492 
  493 //--------------------------------------------------------------------------------------------------
  494 /**
  495  * This function can be used to send an intermediate response.
  496  *
  497  * @return
  498  *      - LE_OK            The function succeeded.
  499  *      - LE_FAULT         The function failed to send the intermediate response.
  500  *
  501  */
  502 //--------------------------------------------------------------------------------------------------
  503 LE_SHARED le_result_t ifgen_le_atServer_SendIntermediateResponse
  504 (
  505     le_msg_SessionRef_t _ifgen_sessionRef,
  506         le_atServer_CmdRef_t commandRef,
  507         ///< [IN] AT command reference
  508         const char* LE_NONNULL intermediateRsp
  509         ///< [IN] Intermediate response to be
  510         ///< sent
  511 );
  512 
  513 //--------------------------------------------------------------------------------------------------
  514 /**
  515  * This function is used to send stored unsolicited reponses.
  516  * It can be used to send unsolicited reponses that were stored before switching to data mode.
  517  *
  518  * @return
  519  *      - LE_OK            The function succeeded.
  520  *      - LE_FAULT         The function failed to send the intermediate response.
  521  *
  522  */
  523 //--------------------------------------------------------------------------------------------------
  524 LE_SHARED le_result_t ifgen_le_atServer_SendStoredUnsolicitedResponses
  525 (
  526     le_msg_SessionRef_t _ifgen_sessionRef,
  527         le_atServer_CmdRef_t commandRef
  528         ///< [IN] AT command reference
  529 );
  530 
  531 //--------------------------------------------------------------------------------------------------
  532 /**
  533  * This function can be used to send the final result code.
  534  *
  535  * @return
  536  *      - LE_OK            The function succeeded.
  537  *      - LE_FAULT         The function failed to send the final result code.
  538  *
  539  */
  540 //--------------------------------------------------------------------------------------------------
  541 LE_SHARED le_result_t ifgen_le_atServer_SendFinalResultCode
  542 (
  543     le_msg_SessionRef_t _ifgen_sessionRef,
  544         le_atServer_CmdRef_t commandRef,
  545         ///< [IN] AT command reference
  546         le_atServer_FinalRsp_t finalResult,
  547         ///< [IN] Final result code to be sent
  548         const char* LE_NONNULL pattern,
  549         ///< [IN] Prefix of the return message
  550         uint32_t errorCode
  551         ///< [IN] Numeric error code
  552 );
  553 
  554 //--------------------------------------------------------------------------------------------------
  555 /**
  556  * This function can be used to send the unsolicited response.
  557  *
  558  * @return
  559  *      - LE_OK            The function succeeded.
  560  *      - LE_FAULT         The function failed to send the unsolicited response.
  561  *
  562  */
  563 //--------------------------------------------------------------------------------------------------
  564 LE_SHARED le_result_t ifgen_le_atServer_SendUnsolicitedResponse
  565 (
  566     le_msg_SessionRef_t _ifgen_sessionRef,
  567         const char* LE_NONNULL unsolRsp,
  568         ///< [IN] Unsolicited response to be
  569         ///< sent
  570         le_atServer_AvailableDevice_t availableDevice,
  571         ///< [IN] device to send the
  572         ///< unsolicited response
  573         le_atServer_DeviceRef_t device
  574         ///< [IN] device reference where the
  575         ///< unsolicited response has to
  576         ///< be sent
  577 );
  578 
  579 //--------------------------------------------------------------------------------------------------
  580 /**
  581  * This function enables echo on the selected device.
  582  *
  583  * @return
  584  *      - LE_OK             The function succeeded.
  585  *      - LE_BAD_PARAMETER  Invalid device reference.
  586  */
  587 //--------------------------------------------------------------------------------------------------
  588 LE_SHARED le_result_t ifgen_le_atServer_EnableEcho
  589 (
  590     le_msg_SessionRef_t _ifgen_sessionRef,
  591         le_atServer_DeviceRef_t device
  592         ///< [IN] device reference
  593 );
  594 
  595 //--------------------------------------------------------------------------------------------------
  596 /**
  597  * This function disables echo on the selected device.
  598  *
  599  * @return
  600  *      - LE_OK             The function succeeded.
  601  *      - LE_BAD_PARAMETER  Invalid device reference.
  602  */
  603 //--------------------------------------------------------------------------------------------------
  604 LE_SHARED le_result_t ifgen_le_atServer_DisableEcho
  605 (
  606     le_msg_SessionRef_t _ifgen_sessionRef,
  607         le_atServer_DeviceRef_t device
  608         ///< [IN] device reference
  609 );
  610 
  611 //--------------------------------------------------------------------------------------------------
  612 /**
  613  * This function opens a AT commands server bridge.
  614  * All unknown AT commands will be sent on this alternative file descriptor thanks to the AT client
  615  * Service.
  616  *
  617  * @return
  618  *      - Reference to the requested bridge.
  619  *      - NULL if the device can't be bridged
  620  */
  621 //--------------------------------------------------------------------------------------------------
  622 LE_SHARED le_atServer_BridgeRef_t ifgen_le_atServer_OpenBridge
  623 (
  624     le_msg_SessionRef_t _ifgen_sessionRef,
  625         int fd
  626         ///< [IN] File descriptor.
  627 );
  628 
  629 //--------------------------------------------------------------------------------------------------
  630 /**
  631  * This function closes an opened bridge.
  632  *
  633  * @return
  634  *      - LE_OK            The function succeeded.
  635  *      - LE_FAULT         The function failed to close the bridge.
  636  *      - LE_BUSY          The bridge is in use (devices references have to be removed first).
  637  */
  638 //--------------------------------------------------------------------------------------------------
  639 LE_SHARED le_result_t ifgen_le_atServer_CloseBridge
  640 (
  641     le_msg_SessionRef_t _ifgen_sessionRef,
  642         le_atServer_BridgeRef_t bridgeRef
  643         ///< [IN] Bridge reference
  644 );
  645 
  646 //--------------------------------------------------------------------------------------------------
  647 /**
  648  * This function adds a device to an opened bridge.
  649  *
  650  * @return
  651  *      - LE_OK            The function succeeded.
  652  *      - LE_BUSY          The device is already used by the bridge.
  653  *      - LE_FAULT         The function failed to add the device to the bridge.
  654  */
  655 //--------------------------------------------------------------------------------------------------
  656 LE_SHARED le_result_t ifgen_le_atServer_AddDeviceToBridge
  657 (
  658     le_msg_SessionRef_t _ifgen_sessionRef,
  659         le_atServer_DeviceRef_t deviceRef,
  660         ///< [IN] Device reference to add to the bridge
  661         le_atServer_BridgeRef_t bridgeRef
  662         ///< [IN] Bridge refence
  663 );
  664 
  665 //--------------------------------------------------------------------------------------------------
  666 /**
  667  * This function removes a device from a bridge
  668  *
  669  * @return
  670  *      - LE_OK            The function succeeded.
  671  *      - LE_NOT_FOUND     The device is not isued by the specified bridge
  672  *      - LE_BUSY          The device is currently in use
  673  *      - LE_FAULT         The function failed to add the device to the bridge.
  674  */
  675 //--------------------------------------------------------------------------------------------------
  676 LE_SHARED le_result_t ifgen_le_atServer_RemoveDeviceFromBridge
  677 (
  678     le_msg_SessionRef_t _ifgen_sessionRef,
  679         le_atServer_DeviceRef_t deviceRef,
  680         ///< [IN] Device reference to add to the bridge
  681         le_atServer_BridgeRef_t bridgeRef
  682         ///< [IN] Bridge refence
  683 );
  684 
  685 //--------------------------------------------------------------------------------------------------
  686 /**
  687  * This function enables verbose error codes on the selected device.
  688  */
  689 //--------------------------------------------------------------------------------------------------
  690 LE_SHARED void ifgen_le_atServer_EnableVerboseErrorCodes
  691 (
  692     le_msg_SessionRef_t _ifgen_sessionRef
  693 );
  694 
  695 //--------------------------------------------------------------------------------------------------
  696 /**
  697  * This function enables extended error codes on the selected device.
  698  */
  699 //--------------------------------------------------------------------------------------------------
  700 LE_SHARED void ifgen_le_atServer_EnableExtendedErrorCodes
  701 (
  702     le_msg_SessionRef_t _ifgen_sessionRef
  703 );
  704 
  705 //--------------------------------------------------------------------------------------------------
  706 /**
  707  * This function disables extended error codes on the selected device.
  708  */
  709 //--------------------------------------------------------------------------------------------------
  710 LE_SHARED void ifgen_le_atServer_DisableExtendedErrorCodes
  711 (
  712     le_msg_SessionRef_t _ifgen_sessionRef
  713 );
  714 
  715 //--------------------------------------------------------------------------------------------------
  716 /**
  717  * This function creates a custom error code.
  718  * @return
  719  *      - ErrorCode    Reference to the created error code
  720  *      - NULL         Function failed to create the error code
  721  *
  722  * @note This function fails to create the error code if the combinaison (errorCode, pattern)
  723  * already exists or if the errorCode number is lower than 512.
  724  *
  725  */
  726 //--------------------------------------------------------------------------------------------------
  727 LE_SHARED le_atServer_ErrorCodeRef_t ifgen_le_atServer_CreateErrorCode
  728 (
  729     le_msg_SessionRef_t _ifgen_sessionRef,
  730         uint32_t errorCode,
  731         ///< [IN] Numerical error code
  732         const char* LE_NONNULL pattern
  733         ///< [IN] Prefix of the response message
  734 );
  735 
  736 //--------------------------------------------------------------------------------------------------
  737 /**
  738  * This function deletes a custom error code.
  739  *
  740  * @return
  741  *      - LE_OK            The function succeeded
  742  *      - LE_FAULT         The function failed to delete the error code
  743  */
  744 //--------------------------------------------------------------------------------------------------
  745 LE_SHARED le_result_t ifgen_le_atServer_DeleteErrorCode
  746 (
  747     le_msg_SessionRef_t _ifgen_sessionRef,
  748         le_atServer_ErrorCodeRef_t errorCodeRef
  749         ///< [IN] Error code reference
  750 );
  751 
  752 //--------------------------------------------------------------------------------------------------
  753 /**
  754  * This function adds a verbose message to a specified error code
  755  *
  756  * @return
  757  *      - LE_OK            The function succeeded
  758  *      - LE_FAULT         The function failed to set the verbose message
  759  */
  760 //--------------------------------------------------------------------------------------------------
  761 LE_SHARED le_result_t ifgen_le_atServer_SetVerboseErrorCode
  762 (
  763     le_msg_SessionRef_t _ifgen_sessionRef,
  764         le_atServer_ErrorCodeRef_t errorCodeRef,
  765         ///< [IN] Error code reference
  766         const char* LE_NONNULL verboseCode
  767         ///< [IN] Verbose message
  768 );
  769 
  770 //--------------------------------------------------------------------------------------------------
  771 /**
  772  * This function allows the user to register a le_atServer_GetTextCallback_t callback
  773  * to retrieve text and sends a prompt <CR><LF><greater_than><SPACE> on the current command's
  774  * device.
  775  *
  776  * @return
  777  *      - LE_OK             The function succeeded.
  778  *      - LE_BAD_PARAMETER  Invalid device or command reference.
  779  */
  780 //--------------------------------------------------------------------------------------------------
  781 LE_SHARED le_result_t ifgen_le_atServer_GetTextAsync
  782 (
  783     le_msg_SessionRef_t _ifgen_sessionRef,
  784         le_atServer_CmdRef_t cmdRef,
  785         ///< [IN] AT command reference
  786         le_atServer_GetTextCallbackFunc_t callbackPtr,
  787         ///< [IN] Get text callback
  788         void* contextPtr
  789         ///< [IN]
  790 );
  791 /** @} **/
  792 #endif // LE_ATSERVER_COMMON_H_INCLUDE_GUARD
LE_ATSERVER_OK
AT command successfully treated. 
Definition: le_atServer_common.h:111
le_atServer_CommandHandlerFunc_t
void(* le_atServer_CommandHandlerFunc_t)(le_atServer_CmdRef_t commandRef, le_atServer_Type_t type, uint32_t parametersNumber, void *contextPtr)
Definition: le_atServer_common.h:179
LE_SHARED
#define LE_SHARED
Definition: le_basics.h:287
le_atServer_Type_t
le_atServer_Type_t
Definition: le_atServer_common.h:90
le_result_t
le_result_t
Definition: le_basics.h:46
le_atServer_FinalRsp_t
le_atServer_FinalRsp_t
Definition: le_atServer_common.h:109
LE_ATSERVER_NO_DIALTONE
No dialtone detected. 
Definition: le_atServer_common.h:117
le_atServer_ErrorCodeRef_t
struct le_atServer_ErrorCode * le_atServer_ErrorCodeRef_t
Definition: le_atServer_common.h:81
LE_ATSERVER_ERROR
Error in AT command treatement. 
Definition: le_atServer_common.h:115
LE_ATSERVER_BUSY
Busy signal detected. 
Definition: le_atServer_common.h:119
LE_ATSERVER_TYPE_READ
Read AT command (e.g. &#39;AT+CMD?&#39;) 
Definition: le_atServer_common.h:98
le_atServer_CmdRegistrationHandlerRef_t
struct le_atServer_CmdRegistrationHandler * le_atServer_CmdRegistrationHandlerRef_t
Definition: le_atServer_common.h:145
le_atDefs_common.h
le_atServer_CmdRegistrationHandlerFunc_t
void(* le_atServer_CmdRegistrationHandlerFunc_t)(le_atServer_CmdRef_t commandRef, void *contextPtr)
Definition: le_atServer_common.h:163
le_atServer_AvailableDevice_t
le_atServer_AvailableDevice_t
Definition: le_atServer_common.h:130
le_atServer_DeviceRef_t
struct le_atServer_Device * le_atServer_DeviceRef_t
Definition: le_atServer_common.h:65
LE_ATSERVER_TYPE_ACT
Action AT command (e.g. &#39;AT+CMD&#39;) 
Definition: le_atServer_common.h:92
le_msg_SessionRef_t
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
le_atServer_CmdRef_t
struct le_atServer_Cmd * le_atServer_CmdRef_t
Definition: le_atServer_common.h:57
legato.h
LE_ATSERVER_TYPE_PARA
AT command received with parameters (e.g. &#39;AT+CMD=x,y&#39;) 
Definition: le_atServer_common.h:94
LE_ATSERVER_SPECIFIC_DEVICE
action will be done on a specified device 
Definition: le_atServer_common.h:134
le_atServer_GetTextCallbackFunc_t
void(* le_atServer_GetTextCallbackFunc_t)(le_atServer_CmdRef_t cmdRef, le_result_t result, const char *LE_NONNULL text, uint32_t len, void *contextPtr)
Definition: le_atServer_common.h:202
le_atServer_BridgeRef_t
struct le_atServer_Bridge * le_atServer_BridgeRef_t
Definition: le_atServer_common.h:73
LE_ATSERVER_NO_CARRIER
Connection terminated. 
Definition: le_atServer_common.h:113
LE_ATSERVER_ALL_DEVICES
action will be done on all bound devices 
Definition: le_atServer_common.h:132
le_atServer_CommandHandlerRef_t
struct le_atServer_CommandHandler * le_atServer_CommandHandlerRef_t
Definition: le_atServer_common.h:153
LE_ATSERVER_TYPE_TEST
Test AT command (e.g. &#39;AT+CMD=?&#39;) 
Definition: le_atServer_common.h:96