Skip to content

Commit

Permalink
Add documentation for Arduino IDE
Browse files Browse the repository at this point in the history
  • Loading branch information
Johboh committed Aug 11, 2024
1 parent df313d0 commit 1ea0cca
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@ There are a set if different variants of this library you can use.
```
Johboh/EspNowNetworkNode@^0.7.1
```
- Add to `idf_component.yml` next to your main component:
- ESP-IDF: Add to `idf_component.yml` next to your main component:
```
dependencies:
johboh/EspNowNetworkNode:
version: ">=0.7.1"
```
- Arduino IDE: Search for `EspNowNetworkNode` by `johboh` in the library manager.
See the [Arduino](https://github.com/Johboh/EspNowNetworkNode/blob/main/examples/arduino/arduino.ino) or [ESP-IDF](https://github.com/Johboh/EspNowNetworkNode/blob/main/examples/espidf/main/main.cpp) for full examples. In short (this is not a complete example):
```c++
struct MyApplicationMessage {
Expand All @@ -57,12 +59,14 @@ There are a set if different variants of this library you can use.
```
Johboh/EspNowNetworkHostDriver@^0.7.1
```
- Add to `idf_component.yml` next to your main component:
- ESP-IDF: Add to `idf_component.yml` next to your main component:
```
dependencies:
johboh/EspNowNetworkHostDriver:
version: ">=0.7.1"
```
- Arduino IDE: Search for `EspNowNetworkHostDriver` by `johboh` in the library manager.
See the [Arduino](https://github.com/Johboh/EspNowNetworkHostDriver/blob/main/examples/arduino/arduino.ino) or [ESP-IDF](https://github.com/Johboh/EspNowNetworkHostDriver/blob/main/examples/espidf/main/main.cpp) for full examples. In short (this is nota complete example):
```c++
DeviceFootPedal _device_foot_pedal_left(0x543204017648, "Left");
Expand Down Expand Up @@ -91,12 +95,13 @@ There are a set if different variants of this library you can use.
```
Johboh/EspNowNetworkHost@^0.7.1
```
- Add to `idf_component.yml` next to your main component:
- ESP-IDF: Add to `idf_component.yml` next to your main component:
```
dependencies:
johboh/EspNowNetworkHost:
version: ">=0.7.1"
```
- Arduino IDE: Search for `EspNowNetworkHost` by `johboh` in the library manager.
- **EspNowNetwork**: This is the legacy full library consiting of both the node and the host code (but not the host driver). Not recommended for new projects. Instead, use the induvidual libraries listed above.
Expand Down

0 comments on commit 1ea0cca

Please sign in to comment.