Tip: If you're coming from the Youtube video, skip to step 11, as all the earlier steps for installing all the prerequisites are the same. The install process is still very similar, just some config settings and file locations have changed
1. Download, unzip and install the CP210x drivers needed to connect the device to you computer from https://www.silabs.com/developer-tools/usb-to-uart-bridge-vcp-drivers?tab=downloads
Ensure to select the correct operating system for the computer you're using.
2. Ensure to go through the entire install process, it should be very straight forward
3. Download, unzip and install the VSC code editor from https://code.visualstudio.com/download Ensure to select the correct operating system for the computer you're using.
4. Once installed, open VSC
5. Select the extensions menu on the left hand sidebar.
6. Search for "PlatformIO", and install it by clicking the install button in the searched list
7. Fully close out of VSC.
8. Click the Address and search bar text field
9. Navigate to https://github.com/brettdottech/info-orbs and download the latest firmware for the device by clicking on the green "Code" button, and the selecting "Download ZIP", then unzip that file
10. Open the file you just downloaded
11. Open the file called"info-orbs.code-workspace"
12. Platform IO will need to configure a bunch of things in the background, this can take as long as 10 minutes, wait before this box at the bottom right is gone before you proceed
13. On the left hand menu, navigate to "config" file directory
14. Rename the "config.h.template" file to just "config.h" (this is a critical step that will result in your code not being able to otherwise compile.
15. Open the config.h file by clicking on it, this is where your will configure your settings for the project, please feel free to play around with the many stylistic/preferential settings, however below are the critical ones:
Change your time zone for the clock(s), you just replace the placeholder "American/Vancouver" with your local timezone identified from this list: [[https://timezonedb.com/time-zones]]
16. change the 24 hour clock format to true for a 24 hour clock, or remain it as false for a 12 hour clock
17. Configure your location for the weather widget using the format city,statecode
18. Set your 5 stocks to be displayed on the stock widget, entering all 5 in a single line as stated in the example, separated by commas.\
- To pull a stock from an international market you may add
&country=Germany(or which ever country you prefer) to identify your local exchange - If you're displaying forex or crypto, ensure to include
/USD(or your given currency) as this will be needed to display the price.
19. Now we're ready to flash the orbs with our firmware, first hold the "boot" button on your esp32
20. While holding the button, click the arrow symbol at the bottom of your VSC window
21. The code will take 15 seconds - 1 minute to compile, keep holding down the boot button until you see "Writing at..." appear in the terminal window, at which point you can release the button
22. Once flashed, you should see this welcome screen, we now just need to configure our wifi credentials.
Take note of the wifi network name your orbs are broadcasting, it will be Info-Orbs_xx
23. Connect to that wifi network using a computer or phone.
24. You should see this window pop up when you connect to the wifi network (may take a few seconds)
25. Should you be connected to the network and the window not pop up for some reason, you can navigate to the IP address listed on your orbs in a chrome browser as another means to access this window.
26. Click "Configure WiFi"
27. Enter your wifi credentials (a list of networks will also appear above to help aid in this), then click save.
28. Your orbs are now connected to wifi and you are done!
If you enter your credentials wrong, or if you ever want to change wifi networks, simply hold the far right button on your orbs while powering them on and it will reset the credentials, allowing you to access the wifi portal again (:
