Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: BLE_file_test BLE_Blink ExternalEncoder
UbloxModem Class Reference
u-blox WCDMA modem (LISA-U200) More...
#include <UbloxModem.h>
Inherits CellularModem.
Inherited by UbloxSerModem, and UbloxUSBModem.
Public Member Functions | |
| UbloxModem (IOStream *atStream, IOStream *pppStream) | |
| Create u-blox API instance. | |
| virtual int | connect (const char *apn=NULL, const char *user=NULL, const char *password=NULL) |
| Open a 3G internet connection. | |
| virtual int | disconnect () |
| Close the internet connection. | |
| virtual int | sendSM (const char *number, const char *message) |
| Send a SM. | |
| virtual int | getSM (char *number, char *message, size_t maxLength) |
| Receive a SM. | |
| virtual int | getSMCount (size_t *pCount) |
| Get the number of SMs in the incoming box. | |
| int | sendUSSD (const char *command, char *result, size_t maxLength) |
| Send a USSD command & wait for its result. | |
| int | getLinkState (int *pRssi, LinkMonitor::REGISTRATION_STATE *pRegistrationState, LinkMonitor::BEARER *pBearer) |
| Get link state. | |
| virtual ATCommandsInterface * | getATCommandsInterface () |
| Get the ATCommandsInterface instance. | |
| virtual int | power (bool enable)=0 |
| Switch power on or off In order to use this function, a pin name must have been entered in the constructor. | |
Protected Member Functions | |
| virtual int | init () |
| Initialise dongle. | |
| virtual int | cleanup () |
| De-initialise dongle. | |
Detailed Description
u-blox WCDMA modem (LISA-U200)
Definition at line 48 of file UbloxModem.h.
Constructor & Destructor Documentation
| UbloxModem | ( | IOStream * | atStream, |
| IOStream * | pppStream | ||
| ) |
Create u-blox API instance.
- Parameters:
-
powerGatingPin Optional pin commanding a power gating transistor on the modem's power line powerGatingOnWhenPinHigh true if the pin needs to be high to power the dongle, defaults to true
Definition at line 31 of file UbloxModem.cpp.
Member Function Documentation
| int cleanup | ( | ) | [protected, virtual] |
De-initialise dongle.
The following actions are performed: 1) Tear down PPP session 2) Set SMS,USSD, and LinkMonitor subsystems to un-initialised 3) Close the AT commands interface
Definition at line 395 of file UbloxModem.cpp.
| int connect | ( | const char * | apn = NULL, |
| const char * | user = NULL, |
||
| const char * | password = NULL |
||
| ) | [virtual] |
Open a 3G internet connection.
- Returns:
- 0 on success, error code on failure
Definition at line 124 of file UbloxModem.cpp.
| int disconnect | ( | ) | [virtual] |
Close the internet connection.
- Returns:
- 0 on success, error code on failure
Definition at line 182 of file UbloxModem.cpp.
| ATCommandsInterface * getATCommandsInterface | ( | ) | [virtual] |
Get the ATCommandsInterface instance.
- Returns:
- Pointer to the ATCommandsInterface instance
Definition at line 313 of file UbloxModem.cpp.
| int getLinkState | ( | int * | pRssi, |
| LinkMonitor::REGISTRATION_STATE * | pRegistrationState, | ||
| LinkMonitor::BEARER * | pBearer | ||
| ) |
Get link state.
- Parameters:
-
pRssi pointer to store the current RSSI in dBm, between -51 dBm and -113 dBm if known; -51 dBm means -51 dBm or more; -113 dBm means -113 dBm or less; 0 if unknown pRegistrationState pointer to store the current registration state pBearer pointer to store the current bearer
- Returns:
- 0 on success, error code on failure
Definition at line 444 of file UbloxModem.cpp.
| int getSM | ( | char * | number, |
| char * | message, | ||
| size_t | maxLength | ||
| ) | [virtual] |
Receive a SM.
- Parameters:
-
number Pointer to a buffer to store the sender's phone number (must be at least 17 characters-long, including the sapce for the null-terminating char) message Pointer to a buffer to store the the incoming message maxLength Maximum message length that can be stored in buffer (including null-terminating character)
- Returns:
- 0 on success, error code on failure
Definition at line 253 of file UbloxModem.cpp.
| int getSMCount | ( | size_t * | pCount ) | [virtual] |
Get the number of SMs in the incoming box.
- Parameters:
-
pCount pointer to store the number of unprocessed SMs on
- Returns:
- 0 on success, error code on failure
Definition at line 283 of file UbloxModem.cpp.
| int init | ( | ) | [protected, virtual] |
Initialise dongle.
The following actions are performed: 1) Start AT interface thread 2) Wait for network registration
Definition at line 318 of file UbloxModem.cpp.
| virtual int power | ( | bool | enable ) | [pure virtual, inherited] |
Switch power on or off In order to use this function, a pin name must have been entered in the constructor.
- Parameters:
-
enable true to switch the dongle on, false to switch it off
- Returns:
- 0 on success, error code on failure
| int sendSM | ( | const char * | number, |
| const char * | message | ||
| ) | [virtual] |
Send a SM.
- Parameters:
-
number The receiver's phone number message The message to send
- Returns:
- 0 on success, error code on failure
Definition at line 223 of file UbloxModem.cpp.
| int sendUSSD | ( | const char * | command, |
| char * | result, | ||
| size_t | maxLength | ||
| ) |
Send a USSD command & wait for its result.
- Parameters:
-
command The command to send result Buffer in which to store the result maxLength Maximum result length that can be stored in buffer (including null-terminating character)
- Returns:
- 0 on success, error code on failure
Definition at line 417 of file UbloxModem.cpp.
Generated on Tue Jul 12 2022 15:21:00 by
1.7.2