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.

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

improve documentation #2

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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: 8 additions & 6 deletions docs/source/compiling.rst
Original file line number Diff line number Diff line change
@@ -33,10 +33,12 @@ A multistage **Docker** environment is used to build firmware and documentation.

.. code:: bash

docker run -d --name fluepdot --device /dev/ttyUSB0:/fluepdot-device:rwm
docker exec -it fluepdot \
-w "/fluepdot/software/firmware" \
-e ESPTOOL_PORT='/fluepdot-device' \
-e ESPTOOL_BAUD='480000' \
make flash
docker run -d --name fluepdot --device /dev/ttyUSB0:/fluepdot-device:rwm fluepdot
docker exec -it -w "/fluepdot/software/firmware" -e ESPTOOL_PORT='/fluepdot-device' -e ESPTOOL_BAUD='480000' fluepdot make flash

5. NOTE: the esp user in the container might not have the rights to access ``/dev/ttyUSB0`` (you will see a permissions denied error when trying to flash). A quick and dirty way to temporarily circumvent this issue is the following

.. code:: bash

sudo chmod 666 /dev/ttyUSB0

3 changes: 3 additions & 0 deletions docs/source/firmware_update.rst
Original file line number Diff line number Diff line change
@@ -15,6 +15,7 @@ Make sure your current user has permission to use the serial port (in this examp
./service_utility -serial.port /dev/ttyUSB0

This utility will flash:

* the partition table
* the bootloader
* the factory application
@@ -29,6 +30,8 @@ You can also flash the firmware using `esptool.py`_. `Download`_ and unpack the

esptool.py --chip esp32 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 4MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 flipdot-firmware.bin

In case the reset circuit on the board does not work and is not able to put the ESP32 into bootloader mode (i.e. because the ESP32 constantly reboots), manually connect the GPIO0 pin to ground to force the bootloader start.

.. _here: https://gitlab.com/fluepke/fluepdot/-/jobs/artifacts/master/raw/software/service_utility/service_utility?job=build_service_utility
.. _esptool.py: https://github.com/espressif/esptool
.. _Download: https://gitlab.com/fluepke/fluepdot/-/jobs/artifacts/master/download?job=build_esp32_image
Binary file added hardware/fluepboard/fluepdot.pdf
Binary file not shown.