mirror of https://github.com/ARMmbed/mbed-os.git
Edit CellularDevice.h
Edit file for complete sentences, consistent tense and correct commas.pull/8852/head
Amanda Butler
GitHub
parent
76672db5cc
commit
411320ad8b
|
|
@ -39,13 +39,13 @@ const int MAX_PLMN_SIZE = 16;
|
|||
* Class CellularDevice
|
||||
*
|
||||
* An abstract interface that defines opening and closing of cellular interfaces.
|
||||
* Deleting/Closing of opened interfaces can be done only via this class.
|
||||
* You can delete or close opened interfaces only through this class.
|
||||
*/
|
||||
class CellularDevice {
|
||||
public:
|
||||
|
||||
/** Return singleton instance of CellularDevice if CELLULAR_DEVICE is defined. If CELLULAR_DEVICE is not
|
||||
* defined then returns NULL. Implementation is marked as weak.
|
||||
/** Returns singleton instance of CellularDevice if CELLULAR_DEVICE is defined. If CELLULAR_DEVICE is not
|
||||
* defined, then it returns NULL. Implementation is marked as weak.
|
||||
*
|
||||
* @return CellularDevice* instance if any
|
||||
*/
|
||||
|
|
@ -63,7 +63,7 @@ public:
|
|||
|
||||
/** Creates a new CellularContext interface.
|
||||
*
|
||||
* @param fh file handle used in communication to modem. Can be for example UART handle. If null then the default
|
||||
* @param fh file handle used in communication to modem. This can be, for example, UART handle. If null, then the default
|
||||
* file handle is used.
|
||||
* @param apn access point to use with context, can be null.
|
||||
*
|
||||
|
|
@ -95,8 +95,8 @@ public:
|
|||
void set_sim_pin(const char *sim_pin);
|
||||
|
||||
/** Plmn to use when registering to cellular network.
|
||||
* If plmn is set then registering is forced to this plmn. If plmn is not set then automatic
|
||||
* registering is used when registering to a cellular network. Does not start any operations.
|
||||
* If plmn is set, then registering is forced to this plmn. If plmn is not set, then automatic
|
||||
* registering is used when registering to a cellular network. It doesn't start any operations.
|
||||
*
|
||||
* @param plmn plmn used when registering to cellular network
|
||||
*/
|
||||
|
|
@ -104,9 +104,9 @@ public:
|
|||
|
||||
/** Start the interface
|
||||
*
|
||||
* Power on the device and does the initializations for communication with the modem..
|
||||
* API is asynchronous. Application can get results from CellularContext callback which is set
|
||||
* with attach(...) or callback which is set by attach(...) in this class.
|
||||
* Powers on the device and does the initializations for communication with the modem.
|
||||
* API is asynchronous. Application can get results from CellularContext callback, which is set
|
||||
* with attach(...), or callback, which is set by attach(...), in this class.
|
||||
*
|
||||
* @return NSAPI_ERROR_OK on success
|
||||
* NSAPI_ERROR_NO_MEMORY on case of memory failure
|
||||
|
|
@ -116,8 +116,8 @@ public:
|
|||
/** Start the interface
|
||||
*
|
||||
* Attempts to open the sim.
|
||||
* API is asynchronous. Application can get results from CellularContext callback which is set
|
||||
* with attach(...) or callback which is set by attach(...) in this class.
|
||||
* API is asynchronous. Application can get results from CellularContext callback, which is set
|
||||
* with attach(...), or callback, which is set by attach(...), in this class.
|
||||
*
|
||||
* @return NSAPI_ERROR_OK on success
|
||||
* NSAPI_ERROR_NO_MEMORY on case of memory failure
|
||||
|
|
@ -127,8 +127,8 @@ public:
|
|||
/** Start the interface
|
||||
*
|
||||
* Attempts to register the device to cellular network.
|
||||
* API is asynchronous. Application can get results from CellularContext callback which is set
|
||||
* with attach(...) or callback which is set by attach(...) in this class.
|
||||
* API is asynchronous. Application can get results from CellularContext callback, which is set
|
||||
* with attach(...), or callback, which is set by attach(...), in this class.
|
||||
*
|
||||
* @return NSAPI_ERROR_OK on success
|
||||
* NSAPI_ERROR_NO_MEMORY on case of memory failure
|
||||
|
|
@ -138,8 +138,8 @@ public:
|
|||
/** Start the interface
|
||||
*
|
||||
* Attempts to attach the device to cellular network.
|
||||
* API is asynchronous. Application can get results from CellularContext callback which is set
|
||||
* with attach(...) or callback which is set by attach(...) in this class.
|
||||
* API is asynchronous. Application can get results from CellularContext callback, which is set
|
||||
* with attach(...), or callback, which is set by attach(...), in this class.
|
||||
*
|
||||
* @return NSAPI_ERROR_OK on success
|
||||
* NSAPI_ERROR_NO_MEMORY on case of memory failure
|
||||
|
|
@ -148,11 +148,11 @@ public:
|
|||
|
||||
/** Register callback for status reporting.
|
||||
*
|
||||
* The specified status callback function will be called on the network and cellular device status changes.
|
||||
* The parameters on the callback are the event type and event-type dependent reason parameter.
|
||||
* The specified status callback function is called on the network, and the cellular device status changes.
|
||||
* The parameters on the callback are the event type and event type dependent reason parameter.
|
||||
*
|
||||
* @remark deleting CellularDevice/CellularContext in callback not allowed.
|
||||
* @remark application should not attach to this function if using CellularContext::attach as it will contain the
|
||||
* @remark deleting CellularDevice/CellularContext in callback is not allowed.
|
||||
* @remark application should not attach to this function if it uses CellularContext::attach because it contains the
|
||||
* same information.
|
||||
*
|
||||
* @param status_cb The callback for status changes.
|
||||
|
|
@ -161,7 +161,7 @@ public:
|
|||
|
||||
/** Create new CellularNetwork interface.
|
||||
*
|
||||
* @param fh file handle used in communication to modem. Can be for example UART handle. If null then the default
|
||||
* @param fh file handle used in communication to modem. This can be, for example, UART handle. If null, then the default
|
||||
* file handle is used.
|
||||
* @return New instance of interface CellularNetwork.
|
||||
*/
|
||||
|
|
@ -169,7 +169,7 @@ public:
|
|||
|
||||
/** Create new CellularSMS interface.
|
||||
*
|
||||
* @param fh file handle used in communication to modem. Can be for example UART handle. If null then the default
|
||||
* @param fh file handle used in communication to modem. This can be, for example, UART handle. If null, then the default
|
||||
* file handle is used.
|
||||
* @return New instance of interface CellularSMS.
|
||||
*/
|
||||
|
|
@ -177,7 +177,7 @@ public:
|
|||
|
||||
/** Create new CellularPower interface.
|
||||
*
|
||||
* @param fh file handle used in communication to modem. Can be for example UART handle. If null then the default
|
||||
* @param fh file handle used in communication to modem. This can be, for example, UART handle. If null, then the default
|
||||
* file handle is used.
|
||||
* @return New instance of interface CellularPower.
|
||||
*/
|
||||
|
|
@ -185,7 +185,7 @@ public:
|
|||
|
||||
/** Create new CellularSIM interface.
|
||||
*
|
||||
* @param fh file handle used in communication to modem. Can be for example UART handle. If null then the default
|
||||
* @param fh file handle used in communication to modem. This can be, for example, UART handle. If null, then the default
|
||||
* file handle is used.
|
||||
* @return New instance of interface CellularSIM.
|
||||
*/
|
||||
|
|
@ -193,7 +193,7 @@ public:
|
|||
|
||||
/** Create new CellularInformation interface.
|
||||
*
|
||||
* @param fh file handle used in communication to modem. Can be for example UART handle. If null then the default
|
||||
* @param fh file handle used in communication to modem. This can be, for example, UART handle. If null, then the default
|
||||
* file handle is used.
|
||||
* @return New instance of interface CellularInformation.
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue