Skip to content

Commit 75ec8da

Browse files
committed
Installation Instructions added to readme.md
1 parent 37823b5 commit 75ec8da

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
11

22
# SinricPro (ESP8266 / ESP32 SDK)
3+
## Installation
4+
This library is designed for use with [platform.io](https://platformio.org/platformio-ide).
5+
We recommend using [VS Code](https://code.visualstudio.com/) as code editor.
36

4-
## usage
5-
#### include SinricPro-Library (SinricPro.h) and SinricPro-Device-Libraries (eg. SinricProSwitch.h)
7+
1. Install [VS Code](https://code.visualstudio.com/)
8+
2. Install [platform.io](https://platformio.org/platformio-ide)
9+
3. Install library by using [Library Manager](https://docs.platformio.org/en/latest/librarymanager/)
10+
4. Follow Quickstart Instructions on [SinricPro](https://help.sinric.pro/pages/quickstart.html)
11+
12+
---
13+
14+
## Dependencies
15+
[ArduinoJson](https://github.com/bblanchon/ArduinoJson)<br>
16+
[WebSocketsClient](https://github.com/Links2004/arduinoWebSockets)<br>
17+
[NTPClient](https://github.com/arduino-libraries/NTPClient)
18+
19+
---
20+
## Usage
21+
#### Include SinricPro-Library (SinricPro.h) and SinricPro-Device-Libraries (eg. SinricProSwitch.h)
622
```C++
723
#include <SinricPro.h>
824
#include <SinricProSwitch.h>
@@ -13,7 +29,7 @@
1329
#define signingKey "your-signing-key"
1430
#define myDeviceId "your-device-id"
1531
```
16-
#### define callback routine(s)
32+
#### Define callback routine(s)
1733
```C++
1834
bool onPowerState(const String deviceId, bool &state) {
1935
Serial.printf("device %s turned %s\r\n, deviceId.c_str(), state?"on":"off");
@@ -863,8 +879,3 @@ bool sendVolumeEvent(int volume, String cause = "PHYSICAL_INTERACTION")
863879
Devices: | [TV](#tv) | [Speaker](#speaker) |
864880
865881
---
866-
867-
## Dependencies / Needed libraries
868-
[ArduinoJson](https://github.com/bblanchon/ArduinoJson)<br>
869-
[WebSocketsClient](https://github.com/Links2004/arduinoWebSockets)<br>
870-
[NTPClient](https://github.com/arduino-libraries/NTPClient)

0 commit comments

Comments
 (0)