Expand Ethernet interface intro #481
Conversation
Make minor copy edits.
There was a problem hiding this comment.
@SeppoTakalo I made some minor copy edits. Please make sure I didn't accidentally change the meaning of anything in the process. Also, I've left two comments for you to address.
| 1. Call the `connect` function. | ||
| 1. Once you connect the EthInterface, you can use it as a | ||
| target for opening [network sockets](/docs/development/reference/network-socket.html). | ||
| ### Configuration |
There was a problem hiding this comment.
I think we should move the content from this section into the connectivity configuration section.
There was a problem hiding this comment.
I don't see that it fits there.
That configuration section is about build time configuration.
This however, refers to the network configuration, how to get the IP address. It is just that you either call the set_network() or not... There is nothing to configure through JSON settings.
Should I change the tittle?
Maybe IP address configuration would be better to reflect this.
| @@ -1,19 +1,45 @@ | |||
| ## Ethernet | |||
|
|
|||
| The EthInterface provides a C++ API for connecting to the internet over Ethernet. | |||
| The `EthInterface` provides a C++ API for connecting to the internet over Ethernet. By default, this class does not require any configuration. It is able to pick up the default Ethernet driver for the target and select the correct network stack. | |||
There was a problem hiding this comment.
Is there anything else developers should know about what this API is and what it does? This section seems short.
There was a problem hiding this comment.
Its hard to see what should be inserted here.
Networking architecture in general is described in #470 and Ethernet MAC drivers will be explained on their own page (to be moved to Handbook later on).
This whole API usage is concised in the 2 line example below in the Usage section.
EthernetInterface eth;
eth.connect();
|
This PR might conflict with #472 so merge that first. |
|
Actually I'll merge this with #470 easier to work when I don't need to wait for PR to be merged. |
@AnotherButler Please review.