ph1p/ikea-led-obegraensad

Update Readme for "Installation and Configuration Plattform IO" example ESP32

Opened this issue · 2 comments

raindancer2204 commented

Hello, this is a really great project. I read the readme and it's really well done.
The only thing missing is for the "normal non-programmers" how can they compile the software with VS Code.

Could sombody pelase update the readme to make it a little better.
If i forgot something, please update. Can someone include this in the readme?

### Install VS Code with Plugin "Platform IO" and Libarys.

  1. Install MS Visuale Studio Code.
  2. Install Plugin "Platform IO" into VS Code.
  3. Download the Project from Github, and open it in your PlatformIO (it will automaticly load dependencies C++ etc)
  4. Add your ESP32 via USB to the PC.
  5. Check in Plugin Platform IO TAB --> Devices that your ESP is connectet via COM PORT
  6. Make a PlatformIO: Clean (Icons in the right bottom corner with a recycle bin)
  7. Add the secrets.h to the include directory and modify Passwords and save it
  8. Start the Platform:IO Build with the Icoon is also located in the right bottom corner.
  9. Read Logfile here are comming hints what libarys are needed.
  10. Go in PlatformIO to the "Icon Libarys" and install the needed libarys.
  11. Try it again, Clean, Build, check logfile and add Libarys if needed.
  12. If all works fine the System will Build the Image.
  13. After this you can start the upload to the ESP32 via "PlatfromIO Upload" in the right bottom corner.

#######################################################################################
Test the Build on the ESP:
After the succesfully upload to ESP32 you can test it via your Mobile Phone.
Unplug and Connect USB Power to the ESP and Check if you see the WLAN "Ikea Display Setup WiFi".
#######################################################################################

JulianBastel commented

Thank you for that information. I flashed with esptool.py but I was not working. Via PlatformIO it is working.

BrookeDot commented

While I agree the documentation could be improved, one of the tricky things is not duplicating and attempting to maintain information that has a source of truth.

In this case, what are your thoughts on linking to the official PlatformIO documentation for many of these steps? For example, I used the following quite heavily when getting started:
https://docs.platformio.org/en/latest/integration/ide/vscode.html#ide-vscode

Another consideration is platform specific documentation, such as COM port for Windows vs dev/ttyUSB0 for MacOS/Linux.

Again I agree with you, but would like some further discussion before taking a stab at the readme updates. Perhaps it makes sense to move things to the Wiki here on GitHub as we now have:

  • Hardware install
  • Software install
  • API Docs
  • Plugin Docs