Skip to content

Commit fc2fbdc

Browse files
finished docs/readme.md
2 parents 71f0b72 + 463d5b8 commit fc2fbdc

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

docs/api.md

+16-3
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_1a7551e64b14a8c04b38de598e12c2a819) | Connects to the network using the specified APN, GPRS username, and GPRS password. |
21+
| [`connect`](#class_arduino_cellular_1a4a879d227df7b0346166218ebd3c2e9b) | 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. |
@@ -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
| [`sendATCommand`](#class_arduino_cellular_1a1d20e97f47d05d5420a98f79f213f978) | Sends an AT command to the modem and waits for a response, then returns the response. |
3333
| [`getNetworkClient`](#class_arduino_cellular_1acff92474af3bd819b62f132cf12f45ba) | Gets the Network client. (OSI Layer 3) |
34+
| [`getSecureNetworkClient`](#class_arduino_cellular_1a8b7486d1a682787588c015af8d65a38e) | Gets the Transport Layer Security (TLS) client. (OSI Layer 4) |
3435
| [`getHTTPClient`](#class_arduino_cellular_1aa1b4c3bbd14984d2a7ed1db7fa1ac930) | Gets the HTTP client for the specified server and port. |
3536
| [`getHTTPSClient`](#class_arduino_cellular_1aeb2d1bff0405e92197c0de750cef87e0) | Gets the HTTPS client for the specified server and port. |
3637
| [`getIPAddress`](#class_arduino_cellular_1aabf2ad2144827d34c3ba298b5f423344) | Gets the local IP address. |
@@ -58,10 +59,10 @@ Initializes the modem.
5859

5960
<hr />
6061

61-
### `connect` <a id="class_arduino_cellular_1a7551e64b14a8c04b38de598e12c2a819" class="anchor"></a>
62+
### `connect` <a id="class_arduino_cellular_1a4a879d227df7b0346166218ebd3c2e9b" class="anchor"></a>
6263

6364
```cpp
64-
bool connect(const char * apn, const char * gprsUser, const char * gprsPass, const char * pin)
65+
bool connect(String apn, String gprsUser, String gprsPass, String pin)
6566
```
6667
6768
Connects to the network using the specified APN, GPRS username, and GPRS password.
@@ -239,6 +240,18 @@ Gets the Network client. (OSI Layer 3)
239240
The GSM client.
240241
<hr />
241242

243+
### `getSecureNetworkClient` <a id="class_arduino_cellular_1a8b7486d1a682787588c015af8d65a38e" class="anchor"></a>
244+
245+
```cpp
246+
BearSSLClient getSecureNetworkClient()
247+
```
248+
249+
Gets the Transport Layer Security (TLS) client. (OSI Layer 4)
250+
251+
#### Returns
252+
The GSM client.
253+
<hr />
254+
242255
### `getHTTPClient` <a id="class_arduino_cellular_1aa1b4c3bbd14984d2a7ed1db7fa1ac930" class="anchor"></a>
243256

244257
```cpp

0 commit comments

Comments
 (0)