Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
doayee authored Mar 27, 2019
1 parent 6061753 commit 85a98cb
Show file tree
Hide file tree
Showing 99 changed files with 23,110 additions and 617 deletions.
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing to esptool.py

## Reporting Issues

Please report bugs in esptool.py if you find them.

However, before reporting a bug please check through the following:

* [Troubleshooting Section](https://github.com/espressif/esptool/#troubleshooting) - common problems and known issues

* [Existing Open Issues](https://github.com/espressif/esptool/issues) - someone might have already encountered this.

If you don't find anything, please [open a new issue](https://github.com/espressif/esptool/issues/new).

## Sending Feature Requests

Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.

There are usually some outstanding feature requests in the [existing issues list](https://github.com/espressif/esptool/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.

## Sending Pull Requests

Pull Requests with changes and fixes are also welcome!

### Code Style & Static Analysis

esptool.py complies with Flake 8 and is valid Python 2 & Python 3 code (in the same source file.)

When you submit a Pull Request, the Travis automated build system will run automated checks for this, using the [flake8 tool](http://flake8.readthedocs.io/en/latest/). If you want to check your code locally before submitting, you can install flake8 and run `python setup.py flake8` to test it.

### Automated Integration Tests

The test directory contains an integration suite with some integration tests for esptool.py:

* `test_imagegen.py` tests the elf2image command and is run automatically by Travis for each Pull Request. You can run this command locally to check for regressions in the elf2image functionality.

* `test_esptool.py` is a [Python unittest](https://docs.python.org/3/library/unittest.html) file that contains integration tests to be run against real ESP8266 or ESP32 hardware. These tests need real hardware so are not run automatically by Travis, they need to be run locally:

`test_esptool.py` takes a command line with the following format:

`./test_esptool.py <serial port> <name of chip> <baud rate> [optional test name(s)]`

For example, to run all tests on an ESP32 board connected to /dev/ttyUSB0, at 230400bps:

`./test_esptool.py /dev/ttyUSB0 esp32 230400`

Or to run the TestFlashing suite only on an ESP8266 board connected to /dev/ttyUSB2` at 460800bps:

`./test_esptool.py /dev/ttyUSB2 esp8266 460800 TestFlashing`

(Note that some tests will fail at higher baud rates on some hardware.)
899 changes: 282 additions & 617 deletions LICENSE

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
include README.md
include LICENSE
# sdist includes test/test*.py by default, but esptool.py tests
# are so far only intended to run from the git repo itself
prune test
prune ecdsa
prune pyaes
prune flasher_stub
prune .github
exclude .git*
exclude .travis*
exclude MANIFEST*


24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# DoayeeESP32DFU

A GUI for ESP32 flashing tool esptool.
**Note:** Currently using esptool v2.6

![gui](esp32bta/dfu/osxgui.PNG "Description goes here")


## Installing

You can download prebuilt executable applications for both Windows and MacOS from ?. These are self-contained applications and have no prerequisites on your system. They have been tested with Windows 10 and macOS Mojave.

## Usage

If you compile your project using make, the App and partition table binaries will be put in your /build directory. The bootloader binary is under /build/bootloader.bin

If the partition table has not been changed, it only needs to be reflashed when the ESP32 has been fully erased. Likewise the bootloader binary will not change between edits to your personal app code. This means only the App needs to be flashed each time

## Running From Source

**Note:** Currently using esptool v2.6

1. Install the project dependencies using your python3 package manager
2. Run the doayee_dfu.py script in python3
Loading

0 comments on commit 85a98cb

Please sign in to comment.