Skip to content

Commit e271cb3

Browse files
committed
Update documentation
1 parent 7d99372 commit e271cb3

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/api.md

Lines changed: 5 additions & 3 deletions
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_1afbd8079987c3a2eb880e57357cbf0d6b) | Connects to the network using the specified APN, GPRS username, and GPRS password. |
21+
| [`connect`](#class_arduino_cellular_1a7551e64b14a8c04b38de598e12c2a819) | 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. |
@@ -58,10 +58,10 @@ Initializes the modem.
5858

5959
<hr />
6060

61-
### `connect` <a id="class_arduino_cellular_1afbd8079987c3a2eb880e57357cbf0d6b" class="anchor"></a>
61+
### `connect` <a id="class_arduino_cellular_1a7551e64b14a8c04b38de598e12c2a819" class="anchor"></a>
6262

6363
```cpp
64-
bool connect(const char * apn, const char * gprsUser, const char * gprsPass)
64+
bool connect(const char * apn, const char * gprsUser, const char * gprsPass, const char * pin)
6565
```
6666
6767
Connects to the network using the specified APN, GPRS username, and GPRS password.
@@ -73,6 +73,8 @@ Connects to the network using the specified APN, GPRS username, and GPRS passwor
7373
7474
* `gprsPass` The GPRS password.
7575
76+
* `pin` The SIM card PIN.
77+
7678
#### Returns
7779
True if the connection is successful, false otherwise.
7880
<hr />

0 commit comments

Comments
 (0)