Skip to content

Commit eaedd2d

Browse files
committed
Update documentation
1 parent ae1f919 commit eaedd2d

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

docs/api.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Members | Descriptions
44
--------------------------------|---------------------------------------------
55
`class ` [`ArduinoCellular`](#class_arduino_cellular) | This class provides methods to interact with the Arduino Pro Modem, such as connecting to the network, sending [SMS](#class_s_m_s) messages, getting GPS location, and more.
6-
`class ` [`ModemInterface`](#class_modem_interface) | Represents the interface to the 4G modem module.
6+
`class ` [`ModemInterface`](#class_modem_interface) | Represents the interface to the 4G modem module which extends the TinyGsmBG96 class.
77
`class ` [`SMS`](#class_s_m_s) | Represents an [SMS](#class_s_m_s) message.
88
`class ` [`Time`](#class_time) | Represents a point in time with year, month, day, hour, minute, second, and offset.
99
`struct ` [`Location`](#struct_location) | Represents a geographic location with latitude and longitude coordinates.
@@ -31,6 +31,7 @@ This class provides methods to interact with the Arduino Pro Modem, such as conn
3131
| [`getUnreadSMS`](#class_arduino_cellular_1af1e3b2fad0a64f3b7675c88100ddbca5) | Gets the list of unread [SMS](#class_s_m_s) messages. |
3232
| [`deleteSMS`](#class_arduino_cellular_1abe4337f0bc8c486a076011309120ace1) | Deletes an [SMS](#class_s_m_s) message at the specified index. |
3333
| [`sendATCommand`](#class_arduino_cellular_1a58a3e3713af0c01ad1075a2509c6874d) | Sends an AT command to the modem and waits for a response, then returns the response. |
34+
| [`sendUSSDCommand`](#class_arduino_cellular_1a6886aec5850836ea8e8f135d4e5632ab) | Sends a USSD command to the network operator and waits for a response. |
3435
| [`getNetworkClient`](#class_arduino_cellular_1acff92474af3bd819b62f132cf12f45ba) | Gets the Network client. (OSI Layer 3) |
3536
| [`getSecureNetworkClient`](#class_arduino_cellular_1a8b7486d1a682787588c015af8d65a38e) | Gets the Transport Layer Security (TLS) client. (OSI Layer 4) |
3637
| [`getHTTPClient`](#class_arduino_cellular_1aa1b4c3bbd14984d2a7ed1db7fa1ac930) | Gets the HTTP client for the specified server and port. |
@@ -243,6 +244,21 @@ Sends an AT command to the modem and waits for a response, then returns the resp
243244
The response from the modem.
244245
<hr />
245246

247+
### `sendUSSDCommand` <a id="class_arduino_cellular_1a6886aec5850836ea8e8f135d4e5632ab" class="anchor"></a>
248+
249+
```cpp
250+
String sendUSSDCommand(const char * command)
251+
```
252+
253+
Sends a USSD command to the network operator and waits for a response.
254+
255+
#### Parameters
256+
* `command` The USSD command to send.
257+
258+
#### Returns
259+
The response from the network operator. (Note: The response may be an [SMS](#class_s_m_s) message or a USSD response)
260+
<hr />
261+
246262
### `getNetworkClient` <a id="class_arduino_cellular_1acff92474af3bd819b62f132cf12f45ba" class="anchor"></a>
247263
248264
```cpp
@@ -346,7 +362,7 @@ class ModemInterface
346362
: public TinyGsmBG96
347363
```
348364

349-
Represents the interface to the 4G modem module.
365+
Represents the interface to the 4G modem module which extends the TinyGsmBG96 class.
350366

351367
## Summary
352368

@@ -355,7 +371,7 @@ Represents the interface to the 4G modem module.
355371
| [`stream`](#class_modem_interface_1a4a8be6e54608e2cbd9704614b807b4b0) | The stream object for communication with the modem. |
356372
| [`powerPin`](#class_modem_interface_1a26e5e7417ff90759520c89776fb0c7f2) | The pin number for controlling the power of the modem. |
357373
| [`ModemInterface`](#class_modem_interface_1aa364cae2d778d717ca1c53a0e4ee8702) | Constructor for the [ModemInterface](#class_modem_interface) class. |
358-
| [`init`](#class_modem_interface_1a2f8f381994be24bb821ace646f7fde9b) | Initializes the modem interface. |
374+
| [`init`](#class_modem_interface_1a2f8f381994be24bb821ace646f7fde9b) | Initializes the modem interface. (Overrides the init method in TinyGsmBG96) |
359375

360376
## Members
361377

@@ -397,7 +413,7 @@ Constructor for the [ModemInterface](#class_modem_interface) class.
397413
inline bool init(const char * pin)
398414
```
399415

400-
Initializes the modem interface.
416+
Initializes the modem interface. (Overrides the init method in TinyGsmBG96)
401417

402418
#### Parameters
403419
* `pin` The PIN code for the SIM card (optional).

0 commit comments

Comments
 (0)