fruchti/colorchord
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README files for Colorchord Embedded

Browse source
This commit is contained in:
Sam Ellicott 2021-02-13 11:23:31 -05:00
parent f8fb768415
commit cae295d989
2 changed files with 104 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

67
embedded8266/README.md
View file

@ -36,3 +36,70 @@ If you have problems with burning the firmware or transfering page data over net
in `makeconf.inc`. This way the esp checks if the flash is written correctly.
Especially with some ESP-01 modules there has been a problem with the flash
not being written correctly.
## Build Instructions
To build colorchord for the esp8266, you first must install the development tools for the esp8266 so that you can compile the code and flash it to the device.
### Setup Toolchain
Follow the instructions in Charles' getting started video to install the toolchain (up until about 3:30 into the video).
[![Toolchain installation video](https://img.youtube.com/vi/LiKNRBIcGII/0.jpg)](https://www.youtube.com/watch?v=LiKNRBIcGII)
The instructions shown in the video are from the [esp82xx repo](https://github.com/cnlohr/esp82xx) on github.
TLDR version: You should really watch the video and look at the other instructions though.
1. if you are on Windows you need to install WSL1 (Windows Subsystem for Linux version 1).
2. Install Python2 and Make
3. Install pip (for Python 2)
4. Install pyserial (for Python 2)
5. Install Charles' prepackaged toolchain to the `~/esp8266` directory (`esp8266` directory in your home folder).
6. Set the `ESP_ROOT` environment variable in your `.profile` or `.bashrc` file. Check to see if one of these files exist (they are hidden by default), if one of them does exist, edit it adding the following line to the file.
```
export ESP_ROOT=$(HOME)/esp8266/esp-open-sdk
```
### Build Colorchord Embedded
At this point you should have your development toolchain set up, now we will download and install colorchord.
Start by cloning this git repository, in a terminal window use the command
```
git clone https://github.com/cnlohr/colorchord.git --recurse-submodules
```
This will download the source code for colorchord and all of its dependencies.
Next, move to the `embedded8266` directory so that we can compile the version of colorchord for the esp8266.
```
cd colorchord/embedded8266
```
Now we will need to build colorchord, this step will need to be done if you make any changes to the colorchord code.
```
make all
```
Hopefully the previous command completed without errors, if it did not, please refer to the [common problems](#common-problems) section. If all went well, there should be three binary files in your build directory `image.elf`, `image.elf-0x00000.bin`, and `image.elf-0x10000.bin`. You can check this with the command
```
ls -l image.elf*
```
### Flash to the ESP8266
Before flashing the program to the esp8266 it must be connected to the computer over a usb-to-serial connection and the correct port on the computer must be known. If using Windows (WSL) this will be the COM port shown by Windows Device Manager. For example, `COM4` in Windows will refer to `/dev/ttyS4` in WSL (See [2:35](https://youtu.be/LiKNRBIcGII?t=155) from the previously mentioned video). On a Linux machine it will most likely be `/dev/ttyUSB0`. The file determined here will specify the `PORT` value in later commands, so if you had `COM4`, then `PORT` would be `/dev/ttyS4`.
If this is your first time using the esp8266 module with colorchord run the following command.
```
PORT=<port value> make erase
PORT=<port value> make burnitall
```
These two commands erase the contents of esp8266 memory and flash the program (and some base files) to it.
If you have made some changes to colorchord and you want to test them use the command
```
PORT=<port_value> make burn
```
### Connect to the ESP8266
If all went well, the esp module should be broadcasting a wifi access point that you can connect to. Once that is done, you should be able to see the colorchord webpage dashboard at the ip address [192.168.4.1](http://192.168.4.1). That should be it! Enjoy using colorchord, and don't hesitate to reach out if you have any issues.
## Common Problems
**Under Construction**
If you experience any issues building colorchord embedded, please open an issue and we will try and work through it. I will try and keep this section up to date with relevant information.