Skip to content

Commit

Permalink
Adds SoftAP fix for NOTE-ESP
Browse files Browse the repository at this point in the history
  • Loading branch information
Bucknalla committed Nov 25, 2024
1 parent 53b4f66 commit 83d03df
Show file tree
Hide file tree
Showing 4 changed files with 461 additions and 0 deletions.
171 changes: 171 additions & 0 deletions python-softap-fix/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
# Dev environment
.vscode/

#virtual environment
.venv/

#assets folder
assets/

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
60 changes: 60 additions & 0 deletions python-softap-fix/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# SoftAP Fix

This script is used to fix Notecard (NOTE-ESP) devices that are missing the
assets required to run SoftAP. This Script should only be run against
ESP32-based Wi-Fi Notecards and not Cell+WiFi or legacy Notecards.

## Requirements

- Python 3

## Usage

1. Make sure you are running Notecard Firmware (`7.4.2` or later). Visit
[blues.dev](https://dev.blues.io/notecard/notecard-firmware-updates/) for
upgrade instructions.

2. Connect the Notecard to your machine via USB (Serial).

3. From a command line, change to the directory containing this `README.md`.

4. Run the instructions below:

1. **LINUX ONLY:** Create a python virtual environment

```bash
sudo apt install python3 python3-venv
python3 -m venv blues-env
source blues-env/bin/activate
```

2. Install requirements and execute the script

```bash
pip install -r requirements.txt
python main.py
```

> _**NOTE:** By DEFAULT this script attempts to identify which serial port
> the Notecard is connected. If it cannot detect which serial port to use,
> you may need to specify which serial port. If the script is unable to
> detect the correct port, then you may
> [manually specify the correct port](#specify-serial-port)_

3. **LINUX ONLY:** Exit the virtual environment

```bash
deactivate
```


### Specify Serial Port (OPTIONAL)

To specify which serial port to use for communicating with the Notecard, use
the following syntax:

```bash
python main.py -p <port-id>
```

where `<port-id>` is the name of the serial port on your operating system.
Loading

0 comments on commit 83d03df

Please sign in to comment.