├── .vscode ├── tasks.json └── cp-web-upload.py ├── LICENSE ├── README.md └── .gitignore /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | // See https://go.microsoft.com/fwlink/?LinkId=733558 3 | // for the documentation about the tasks.json format 4 | "version": "2.0.0", 5 | "tasks": [ 6 | { 7 | "label": "Upload", 8 | "type": "shell", 9 | "command": "python3 .vscode/cp-web-upload.py '${workspaceFolder}' '${relativeFile}'", 10 | "presentation": { 11 | "echo": true, 12 | "reveal": "silent", 13 | "focus": false, 14 | "panel": "shared", 15 | "showReuseMessage": true, 16 | "clear": false 17 | }, 18 | "problemMatcher": [] 19 | } 20 | ] 21 | } 22 | 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Luke Williams 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.vscode/cp-web-upload.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import os 3 | import requests 4 | from dotenv import load_dotenv 5 | load_dotenv() 6 | 7 | baseURL = "http://cpy-daa7a1.local/fs/" 8 | 9 | password = os.getenv("CIRCUITPY_WEB_API_PASSWORD") 10 | workspaceFolder = sys.argv[1] 11 | relativeFile = sys.argv[2] 12 | 13 | def create_parent_directory(relative_path): 14 | relative_path = relative_path.removesuffix("/") 15 | print("Creating parent directory for:",relative_path) 16 | directory = relative_path.replace(relative_path.split("/")[-1],"") 17 | dir_response = requests.put(baseURL + directory, auth=("",password)) 18 | if(dir_response.status_code == 201): 19 | print("Directory created:", directory) 20 | else: 21 | print(dir_response.status_code, dir_response.reason) 22 | 23 | response = requests.put(baseURL + relativeFile, data=open(workspaceFolder + "/" + relativeFile,"rb"), auth=("",password)) 24 | if(response.status_code == 201): 25 | print("Created file:", relativeFile) 26 | elif(response.status_code == 204): 27 | print("Overwrote file:", relativeFile) 28 | elif(response.status_code == 401): 29 | print("Incorrect password") 30 | elif(response.status_code == 403): 31 | print("CIRCUITPY_WEB_API_PASSWORD not set") 32 | elif(response.status_code == 404): 33 | print("Missing parent directory") 34 | create_parent_directory(relativeFile) 35 | retry_response = requests.put(baseURL + relativeFile, data=open(workspaceFolder + "/" + relativeFile,"rb"), auth=("",password)) 36 | if(retry_response.status_code == 201): 37 | print("Created file:", relativeFile) 38 | else: 39 | print(retry_response.status_code, retry_response.reason) 40 | elif(response.status_code == 409): 41 | print("USB is active and preventing file system modification") 42 | else: 43 | print(response.status_code, response.reason) 44 | 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # vscode-circuitpython-webupload 2 | Task definition and Python script to upload from VS Code to CircuitPython board via web workflow REST API. 3 | 4 | CircuitPython 8.x adds [web workflow](https://docs.circuitpython.org/en/latest/docs/workflows.html#web) allowing code to be edited/uploaded via the local network. There is built-in browser support and also a Web REST API. This project utilizes the latter to upload a file directly from VS Code. 5 | 6 | ***NOTE: ~~This is very rough and you will find some bugs.~~ No major bugs so far, but PRs for improvement appreciated!*** 7 | 8 | ## Setup 9 | * Python 3 installed and in your path. 10 | * [requests](https://pypi.org/project/requests/) and [python-dotenv](https://pypi.org/project/python-dotenv/) 11 | * CircuitPython 8.x on your board. 12 | * Board connected to same Wi-Fi with web workflow configured and reachable from machine running VS Code. 13 | * [This is for ESP32 (original) but should be close enough for any of the ESP32-S2 or S3 boards, also](https://learn.adafruit.com/circuitpython-with-esp32-quick-start/setting-up-web-workflow). 14 | * Copy .vscode directory from this project to the root of your CircuitPython project. It does not have to be copied to your CircuitPython board, just the machine running VS Code. 15 | * Edit .vscode/cp-web-upload.py and set _baseURL_. 16 | * Web API password is taken from .env 17 | * From the file you want to upload, execute the "Run Task..." command. 18 | * Menu: _Terminal, Run Task..._ 19 | * Command pallet: _Tasks: Run Task_ 20 | * Shortcut keys: TODO:DOCUMENT_THESE 21 | * [Keybindings can be configured to call a specific task](https://code.visualstudio.com/docs/editor/tasks#_binding-keyboard-shortcuts-to-tasks). 22 | 23 | ## Notes 24 | * Directories in the file's path are created if they don't exist. 25 | * Only single files can be uploaded. 26 | * Moved files will be recreated in the new location but the old file/directories will not be removed. 27 | * Existing files will be overwritten, even if they haven't changed. 28 | 29 | ## TODO 30 | - [X] get password from /.env 31 | - [ ] set/get URL from /.env 32 | - [ ] Get timestamp from source file and set on new file 33 | - [ ] use argparse 34 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | --------------------------------------------------------------------------------