Skip to content

Commit e7bd4ee

Browse files
committed
Update documentation
1 parent 4e7f9d3 commit e7bd4ee

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

docs/api.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This class provides methods to interact with the Arduino Pro Modem, such as conn
1818
--------------------------------|---------------------------------------------
1919
| [`ArduinoCellular`](#class_arduino_cellular_1a96d1d9f3fbe80adc3d460b4364d47870) | Default constructor. |
2020
| [`begin`](#class_arduino_cellular_1ad5ca7cf61f48c40569f41f3029d6516e) | Initializes the modem. |
21-
| [`connect`](#class_arduino_cellular_1a4a879d227df7b0346166218ebd3c2e9b) | Connects to the network using the specified APN, GPRS username, and GPRS password. |
21+
| [`connect`](#class_arduino_cellular_1a041c9d5c546b82858b01859383d11fb7) | Connects to the network using the specified APN, GPRS username, and GPRS password. |
2222
| [`isConnectedToOperator`](#class_arduino_cellular_1af7453ef90702e9042e2b4b18fa89db03) | Checks if the modem is registered on the network. |
2323
| [`isConnectedToInternet`](#class_arduino_cellular_1a6f8251e06de1810897b8bd8f8fb1b1a2) | Checks if the GPRS network is connected. |
2424
| [`enableGPS`](#class_arduino_cellular_1abe77a53e0eba6e8d62ba5db3bb6f5e92) | Enables or disables the GPS module. |
@@ -36,6 +36,7 @@ This class provides methods to interact with the Arduino Pro Modem, such as conn
3636
| [`getHTTPSClient`](#class_arduino_cellular_1aeb2d1bff0405e92197c0de750cef87e0) | Gets the HTTPS client for the specified server and port. |
3737
| [`getIPAddress`](#class_arduino_cellular_1aabf2ad2144827d34c3ba298b5f423344) | Gets the local IP address. |
3838
| [`getSignalQuality`](#class_arduino_cellular_1aefdae9cb2b8c9f05130b09c18c3f245e) | Gets the signal quality. |
39+
| [`setDebugStream`](#class_arduino_cellular_1aae2cacf5a5778293f0bd3312d2289327) | Sets the debug stream for [ArduinoCellular](#class_arduino_cellular). |
3940

4041
## Members
4142

@@ -59,7 +60,7 @@ Initializes the modem.
5960

6061
<hr />
6162

62-
### `connect` <a id="class_arduino_cellular_1a4a879d227df7b0346166218ebd3c2e9b" class="anchor"></a>
63+
### `connect` <a id="class_arduino_cellular_1a041c9d5c546b82858b01859383d11fb7" class="anchor"></a>
6364

6465
```cpp
6566
bool connect(String apn, String gprsUser, String gprsPass, String pin)
@@ -310,6 +311,20 @@ Gets the signal quality.
310311
The signal quality.
311312
<hr />
312313

314+
### `setDebugStream` <a id="class_arduino_cellular_1aae2cacf5a5778293f0bd3312d2289327" class="anchor"></a>
315+
316+
```cpp
317+
void setDebugStream(Stream & stream)
318+
```
319+
320+
Sets the debug stream for [ArduinoCellular](#class_arduino_cellular).
321+
322+
This function allows you to set the debug stream for [ArduinoCellular](#class_arduino_cellular). The debug stream is used to output debug messages and information.
323+
324+
#### Parameters
325+
* `stream` A pointer to the Stream object that will be used as the debug stream.
326+
<hr />
327+
313328
# class `ModemInterface` <a id="class_modem_interface" class="anchor"></a>
314329
315330
```cpp

0 commit comments

Comments
 (0)