Skip to content

Adding WiFiS3 API documentation #415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Mar 13, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
ecab85d
API documentation
BenjaminDannegard Nov 26, 2024
12a02c9
Api docs
BenjaminDannegard Nov 26, 2024
45de986
Added API tags
BenjaminDannegard Nov 27, 2024
c116b89
GPT fix
BenjaminDannegard Nov 27, 2024
38503fe
Update
BenjaminDannegard Nov 27, 2024
38d6751
Update
BenjaminDannegard Nov 27, 2024
96df3e6
Updated API docs
BenjaminDannegard Nov 27, 2024
17f2913
Merge branch 'arduino:main' into benjamindannegard/api-documentation
BenjaminDannegard Nov 27, 2024
003c19d
Updated API
BenjaminDannegard Nov 27, 2024
c74ed4d
Add API docs workflow
sebromero Nov 27, 2024
c8716e0
api docs update
BenjaminDannegard Nov 27, 2024
ff3171e
Added more documentation
BenjaminDannegard Dec 2, 2024
ae58089
More api documentation
BenjaminDannegard Dec 3, 2024
fb14228
Fixed wifi.h api docs
BenjaminDannegard Dec 3, 2024
6a4093e
Finished API docs
BenjaminDannegard Dec 3, 2024
c0a276e
Merge pull request #1 from BenjaminDannegard/docs
BenjaminDannegard Dec 3, 2024
70bf179
First api.h draft
BenjaminDannegard Dec 4, 2024
6b8ebbb
Fixed for formating
BenjaminDannegard Dec 9, 2024
be2e2fb
Fixed api docs file
BenjaminDannegard Dec 9, 2024
5fb1ea3
Merge pull request #2 from BenjaminDannegard/benjamindannegard/api-do…
BenjaminDannegard Dec 10, 2024
20a2010
Update documentation
actions-user Dec 10, 2024
1399224
Removed unused tags
BenjaminDannegard Dec 13, 2024
a382728
Fixed formatting
BenjaminDannegard Dec 13, 2024
af1a452
Merge branch 'main' into main
BenjaminDannegard Feb 3, 2025
a994343
Merge branch 'main' into main
BenjaminDannegard Feb 13, 2025
1ac8280
Merge branch 'arduino:main' into main
BenjaminDannegard Feb 27, 2025
375fef3
Removed workflow
BenjaminDannegard Feb 27, 2025
f2d11bf
Removed duplicate functions
BenjaminDannegard Feb 27, 2025
4a741b7
Revert "Removed duplicate functions"
BenjaminDannegard Feb 27, 2025
af03bb1
Removed duplicate functions
BenjaminDannegard Feb 27, 2025
b7a620a
Merge branch 'main' into main
BenjaminDannegard Mar 3, 2025
0ab369b
Merge branch 'main' into main
sebromero Mar 13, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Merge branch 'main' into main
  • Loading branch information
BenjaminDannegard authored Feb 3, 2025
commit af1a45237f078e3669cf5e905c29405f40c8248f
9 changes: 3 additions & 6 deletions libraries/WiFiS3/src/Modem.h
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,9 @@ class ModemClass {
* to be read is considered for processing.
*/
void read_using_size() {
read_by_size = true;
}

/**
* @brief Flag indicating whether the system has been initialized.
*/
// read_by_size = true; // deprecated
}

bool beginned;

/* Calling this function with no argument will enable debug message to be printed
Expand Down
24 changes: 17 additions & 7 deletions libraries/WiFiS3/src/WiFi.h
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,21 @@ class CWifi {
*/
int begin(const char* ssid);

/**
* @brief start WiFi connection with passphrase the most secure
* supported mode will be automatically selected.
/*
* PING
*/
int ping(IPAddress ip, uint8_t ttl = 128, uint8_t count = 1);
int ping(const String &hostname, uint8_t ttl = 128, uint8_t count = 1);
int ping(const char* host, uint8_t ttl = 128, uint8_t count = 1);

/*
* Start WiFi connection for OPEN networks
* param ssid: Pointer to the SSID string.
*/
int begin(const char* ssid);

/* Start WiFi connection with passphrase
* the most secure supported mode will be automatically selected
*
* @param `ssid` Pointer to the SSID string.
* @param `passphrase` Passphrase. Valid characters in a passphrase
Expand Down Expand Up @@ -186,7 +198,7 @@ class CWifi {
* @param `subnet` The static subnet mask to use for the network.
*/
void config(IPAddress local_ip, IPAddress dns_server, IPAddress gateway, IPAddress subnet);

/**
* @brief Sets the primary DNS server for the Wi-Fi connection.
*
Expand Down Expand Up @@ -221,7 +233,6 @@ class CWifi {
*/
void end(void);


/**
* @brief Retrieves the MAC address of the device.
*
Expand All @@ -232,7 +243,7 @@ class CWifi {
*
* @param `_mac` A pointer to a uint8_t array where the MAC address will be stored.
*
* @return uint8_t* The pointer to the array containing the MAC address.
* @return uint8_t* The pointer to the array with length WL_MAC_ADDR_LENGTH.
*/
uint8_t* macAddress(uint8_t* mac);

Expand Down Expand Up @@ -277,7 +288,6 @@ class CWifi {
*/
IPAddress dnsIP(int n = 0);


/**
* @brief Retrieves the IP address of the soft access point (AP).
*
Expand Down
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.