Skip to content

Commit

Permalink
add instructions to README to use mip installed boot and main files, …
Browse files Browse the repository at this point in the history
…see #32 and #33
  • Loading branch information
brainelectronics committed Jun 12, 2023
1 parent d4f2753 commit fb6d02e
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ MicroPython WiFi Manager to configure and connect to networks
- [Upload files to board](#upload-files-to-board)
- [Install package](#install-package)
- [General](#general)
- [Hook the WiFi Manager boot logic](#hook-the-wifi-manager-boot-logic)
- [Specific version](#specific-version)
- [Test version](#test-version)
- [Manually](#manually)
Expand Down Expand Up @@ -105,6 +106,23 @@ upip.install('micropython-esp-wifi-manager')
# dependencies will be installed automatically
```

#### Hook the WiFi Manager boot logic

The `boot.py` and `main.py` files of this package are installed into `/lib` of
the MicroPython device by `mip`. They are fully functional and without any
other dependencies or MicroPython port specific commands. Simply add the
following line to the `boot.py` file of your device.

```python
from wifi_manager import boot
```

And also add this line to your `main.py`, before your application code

```python
from wifi_manager import main
```

#### Specific version

Install a specific, fixed package version of this lib on the MicroPython device
Expand Down
14 changes: 13 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ r"^\#\# \[\d{1,}[.]\d{1,}[.]\d{1,}\] \- \d{4}\-\d{2}-\d{2}$"
<!-- ## [Unreleased] -->

## Released
## [1.12.0] - 2023-06-12
### Added
- Instructions for using this package `boot.py` and `main.py` files
- `boot.py` and `main.py` are part of `package.json` and are installed into `wifi_manager/`, see #32 and #33

### Changed
- Ignore boot and main files during `package.json` validation

### Removed
- No device specific dependencies in `boot.py` to LED

## [1.11.0] - 2023-05-27
### Added
- `package.json` file and installation instruction for `mip` usage, see #30
Expand Down Expand Up @@ -261,8 +272,9 @@ r"^\#\# \[\d{1,}[.]\d{1,}[.]\d{1,}\] \- \d{4}\-\d{2}-\d{2}$"
- `sendfile` function implemented in same way as on Micropythons PicoWeb

<!-- Links -->
[Unreleased]: https://github.com/brainelectronics/Micropython-ESP-WiFi-Manager/compare/1.11.0...develop
[Unreleased]: https://github.com/brainelectronics/Micropython-ESP-WiFi-Manager/compare/1.12.0...develop

[1.12.0]: https://github.com/brainelectronics/Micropython-ESP-WiFi-Manager//tree/1.12.0
[1.11.0]: https://github.com/brainelectronics/Micropython-ESP-WiFi-Manager//tree/1.11.0
[1.10.0]: https://github.com/brainelectronics/Micropython-ESP-WiFi-Manager//tree/1.10.0
[1.9.0]: https://github.com/brainelectronics/Micropython-ESP-WiFi-Manager//tree/1.9.0
Expand Down

0 comments on commit fb6d02e

Please sign in to comment.