Skip to content

Commit e8fc559

Browse files
Starting to fix up the readme
1 parent 942846a commit e8fc559

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

README.md

+31-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,36 @@
1-
steps
1+
#Setup for the Adafruit Huzzah
22
-------------
33

4-
Click the DOWNLOADS button in the top right corner, rename the uncompressed folder Spacebrew. Check that the Spacebrew folder contains Spacebrew.cpp and Spacebrew.h
5-
6-
Place the Spacebrew library folder your <arduinosketchfolder>/libraries/ folder. You may need to create the libraries subfolder if its your first library.
7-
8-
Also download and install the WebSocketClient library from https://github.com/labatrockwell/ArduinoWebsocketClient
9-
10-
Restart the IDE.
4+
1. Make sure you follow the [Adafruit setup guide](https://learn.adafruit.com/adafruit-feather-huzzah-esp8266/using-arduino-ide)
5+
2. Download or clone this library into your <arduinosketchfolder>/libraries/ folder
6+
* First, if you don't have a 'libraries' folder, create it!
7+
* Download:
8+
* Click the DOWNLOADS above, and download a zip of this repo
9+
* Move the whole folder into <arduinosketchfolder>/libraries/
10+
* Rename the folder to "Spacebrew"
11+
* Clone:
12+
```
13+
$cd <arduinosketchfolder>/libraries/
14+
$git clone https://github.com/mattfelsen/spacebrew-esp8266.git Spacebrew
15+
```
16+
17+
3. Download dependencies:
18+
* https://github.com/Links2004/arduinoWebSockets
19+
* https://github.com/me-no-dev/ESPAsyncTCP
20+
21+
4. Edit the Websockets library to turn on 'async' mode
22+
* Open ```Websockets.h``` in arduinoWebSockets/src
23+
* Comment out line 57, and uncomment line 58. It should look like this:
24+
```
25+
#if defined(ESP8266) || defined(ESP31B)
26+
//#define WEBSOCKETS_NETWORK_TYPE NETWORK_ESP8266
27+
#define WEBSOCKETS_NETWORK_TYPE NETWORK_ESP8266_ASYNC
28+
#else
29+
#define WEBSOCKETS_NETWORK_TYPE NETWORK_W5100
30+
#endif
31+
```
32+
33+
5. Restart the Arduino IDE, if you had it running!
1134
1235
includes
1336
--------------

0 commit comments

Comments
 (0)