Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplified instruction for @PlatformIO #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Simplified instruction for @PlatformIO #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,16 @@ OLED Pins -> ESP8266 Pins
To load the firmware onto the ESP8266 I used Platformio.

* Install the drivers for your ESP8266/NodeMCU board.
* Install platformio
* Install the correct board for platformio to know what to build against
* Install [PlatformIO IDE](http://platformio.org/platformio-ide)
* Clone this repository or download ZIP archive (unpack it)
* PlatformIO IDE `Menu: PlatformIO > Open Project folder`, where specify path to folder that contains `platformio.ini`.
* Install the correct board for PlatformIO (`Menu: PlatformIO > Initialize or Update PlatformIO Project`) to know what to build against
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should have the option for installing the board via CLI as well

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PlatformIO CLI is good, but PlatformIO IDE is better and works "from a box". Should we add CLI steps?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. In my opinion, CLI steps should be primary, and IDE should be
secondary. In either case, both should be on every step.

* I've included my platformio.ini file for reference
* Install libraries 561, 562 and 563 with "platformio lib install"
* `pio lib install 561`
* `pio lib install 562`
* `pio lib install 563`
* Sanity check yourself by running a hello world blink program using the onboard LED. If you are stuck with anything before this, google + stack overflow will be your best friends.
* Build and upload the firmware
* `pio run -t upload`
* `Menu: PlatformIO > Upload` or using CLI `pio run -t upload`
* Monitor the Serial connection for debugging purposes
* `pio -f -c atom serialports monitor --port /dev/cu.wchusbserial1410 --baud 115200`
* `Menu: PlatformIO > Serial Monitor` or using CLI `pio device monitor --baud 115200`
* Profit!

Happy War Walking y'all!
Expand Down