Skip to content

Commit 33325ea

Browse files
committed
macAddress: add function description
1 parent d2c2f56 commit 33325ea

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

libraries/SocketWrapper/src/SocketHelpers.h

+19
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,26 @@ class MbedSocketClass {
128128

129129
int hostByName(const char* aHostname, IPAddress& aResult);
130130

131+
/*
132+
* Get the interface MAC address.
133+
*
134+
* Network interface should be ready to get a valid mac address.
135+
* Call WiFi.begin("",""); or Ethernet.begin(); before issuing a mac address
136+
* request, otherwhise returned value will be ff:ff:ff:ff:ff:ff
137+
*
138+
* return: pointer to uint8_t array with length WL_MAC_ADDR_LENGTH
139+
*/
131140
uint8_t* macAddress(uint8_t* mac);
141+
142+
/*
143+
* Get the interface MAC address String.
144+
*
145+
* Network interface should be ready to get a valid MAC address.
146+
* Call WiFi.begin("",""); or Ethernet.begin(); before issuing a mac address
147+
* request, otherwhise returned value will be ff:ff:ff:ff:ff:ff
148+
*
149+
* return: MAC Address String
150+
*/
132151
String macAddress();
133152

134153
void setFeedWatchdogFunc(voidFuncPtr func);

0 commit comments

Comments
 (0)