{"id":13802641,"url":"https://github.com/brainelectronics/micropython-winbond","last_synced_at":"2026-03-10T02:02:08.684Z","repository":{"id":43722713,"uuid":"460327575","full_name":"brainelectronics/micropython-winbond","owner":"brainelectronics","description":"Micropython library to interact with Winbond Flash chips","archived":false,"fork":false,"pushed_at":"2024-05-30T18:16:07.000Z","size":59,"stargazers_count":12,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-31T20:55:51.530Z","etag":null,"topics":["flash","library","micropython","micropython-lib","winbond"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brainelectronics.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-17T07:31:34.000Z","updated_at":"2025-01-13T14:59:29.000Z","dependencies_parsed_at":"2024-08-04T00:17:58.523Z","dependency_job_id":null,"html_url":"https://github.com/brainelectronics/micropython-winbond","commit_stats":{"total_commits":26,"total_committers":2,"mean_commits":13.0,"dds":"0.038461538461538436","last_synced_commit":"b60b85f05fc2814b0a74c8c6de75c59fd48ebc6a"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brainelectronics%2Fmicropython-winbond","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brainelectronics%2Fmicropython-winbond/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brainelectronics%2Fmicropython-winbond/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brainelectronics%2Fmicropython-winbond/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brainelectronics","download_url":"https://codeload.github.com/brainelectronics/micropython-winbond/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238347897,"owners_count":19457012,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flash","library","micropython","micropython-lib","winbond"],"created_at":"2024-08-04T00:01:49.239Z","updated_at":"2025-10-26T15:30:23.298Z","avatar_url":"https://github.com/brainelectronics.png","language":"Python","readme":"# MicroPython Winbond Flash\n\n[![Downloads](https://pepy.tech/badge/micropython-winbond)](https://pepy.tech/project/micropython-winbond)\n![Release](https://img.shields.io/github/v/release/brainelectronics/micropython-winbond?include_prereleases\u0026color=success)\n![MicroPython](https://img.shields.io/badge/micropython-Ok-green.svg)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![CI](https://github.com/brainelectronics/micropython-winbond/actions/workflows/release.yml/badge.svg)](https://github.com/brainelectronics/micropython-winbond/actions/workflows/release.yml)\n\nMicroPython library to interact with Winbond W25Q Flash chips\n\n📚 The latest documentation is available at\n[MicroPython Winbond ReadTheDocs][ref-rtd-micropython-winbond] 📚\n\n-----------------------\n\n\u003c!-- MarkdownTOC --\u003e\n\n- [Installation](#installation)\n    - [Install required tools](#install-required-tools)\n- [Stetup](#stetup)\n    - [Install package](#install-package)\n        - [General](#general)\n        - [Specific version](#specific-version)\n        - [Test version](#test-version)\n    - [Manually](#manually)\n        - [Upload files to board](#upload-files-to-board)\n- [Usage](#usage)\n- [Credits](#credits)\n\n\u003c!-- /MarkdownTOC --\u003e\n\n## Installation\n\n### Install required tools\n\nPython3 must be installed on your system. Check the current Python version\nwith the following command\n\n```bash\npython --version\npython3 --version\n```\n\nDepending on which command `Python 3.x.y` (with x.y as some numbers) is\nreturned, use that command to proceed.\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\n\npip install -r requirements.txt\n```\n\nFor interaction with the filesystem of the device the\n[Remote MicroPython shell][ref-remote-upy-shell] can be used.\n\nTest the tool by showing its man/help info description.\n\n```bash\nrshell --help\n```\n\n## Stetup\n\n### Install package\n\nConnect the MicroPython device to a network (if possible)\n\n```python\nimport network\nstation = network.WLAN(network.STA_IF)\nstation.active(True)\nstation.connect('SSID', 'PASSWORD')\nstation.isconnected()\n```\n\n#### General\n\nInstall the latest package version of this lib on the MicroPython device\n\n```python\nimport mip\nmip.install(\"github:brainelectronics/micropython-winbond\")\n```\n\nFor MicroPython versions below 1.19.1 use the `upip` package instead of `mip`\n\n```python\nimport upip\nupip.install('micropython-winbond')\n```\n\n#### Specific version\n\nInstall a specific, fixed package version of this lib on the MicroPython device\n\n```python\nimport mip\n# install a verions of a specific branch\nmip.install(\"github:brainelectronics/micropython-winbond\", version=\"feature/add-docs-and-detailed-examples\")\n# install a tag version\nmip.install(\"github:brainelectronics/micropython-winbond\", version=\"0.4.0\")\n```\n\nFor MicroPython versions below 1.19.1 use the `upip` package instead of `mip`.\nWith `upip` always the latest available version will be installed.\n\n```python\nimport upip\nupip.install('micropython-winbond')\n```\n\n#### Test version\n\nInstall a specific release candidate version uploaded to\n[Test Python Package Index](https://test.pypi.org/) on every PR on the\nMicroPython device. If no specific version is set, the latest stable version\nwill be used.\n\n```python\nimport mip\nmip.install(\"github:brainelectronics/micropython-winbond\", version=\"0.4.0-rc2.dev4\")\n```\n\nFor MicroPython versions below 1.19.1 use the `upip` package instead of `mip`.\nWith `upip` always the latest available version will be installed.\n\n```python\nimport upip\n# overwrite index_urls to only take artifacts from test.pypi.org\nupip.index_urls = ['https://test.pypi.org/pypi']\nupip.install('micropython-winbond')\n```\n\nSee also [brainelectronics Test PyPi Server in Docker][ref-brainelectronics-test-pypiserver]\nfor a test PyPi server running on Docker.\n\n### Manually\n\n#### Upload files to board\n\nCopy the module to the MicroPython board and import them as shown below\nusing [Remote MicroPython shell][ref-remote-upy-shell]\n\nOpen the remote shell with the following command. Additionally use `-b 115200`\nin case no CP210x is used but a CH34x.\n\n```bash\nrshell -p /dev/tty.SLAB_USBtoUART --editor nano\n```\n\nPerform the following command inside the `rshell` to copy all files and\nfolders to the device\n\n```bash\nmkdir /pyboard/lib\nmkdir /pyboard/lib/winbond\n\ncp winbond/* /pyboard/lib/winbond\ncp main.py /pyboard/lib/winbond\ncp boot.py /pyboard/lib/winbond\n```\n\n## Usage\n\n```python\nfrom machine import SPI, Pin\nimport os\nfrom winbond import W25QFlash\n\n# the used SPI and CS pin is setup specific, change accordingly\n# check the boot.py file of this repo for further boards\nflash = W25QFlash(spi=SPI(2), cs=Pin(5), baud=2000000, software_reset=True)\n\nflash_mount_point = '/external'\n\ntry:\n    os.mount(flash, flash_mount_point)\nexcept Exception as e:\n    if e.errno == 19:\n        # [Errno 19] ENODEV aka \"No such device\"\n        # create the filesystem, this takes some seconds (approx. 10 sec)\n        print('Creating filesystem for external flash ...')\n        print('This might take up to 10 seconds')\n        os.VfsFat.mkfs(flash)\n    else:\n        # takes some seconds/minutes (approx. 40 sec for 128MBit/16MB)\n        print('Formatting external flash ...')\n        print('This might take up to 60 seconds')\n        # !!! only required on the very first start (will remove everything)\n        flash.format()\n\n        # create the filesystem, this takes some seconds (approx. 10 sec)\n        print('Creating filesystem for external flash ...')\n        print('This might take up to 10 seconds')\n        # !!! only required on first setup and after formatting\n        os.VfsFat.mkfs(flash)\n\n    print('Filesystem for external flash created')\n\n    # finally mount the external flash\n    os.mount(flash, flash_mount_point)\n```\n\n## Credits\n\nKudos and big thank you to [crizeo of the MicroPython Forum][ref-crizeo] and\nhis [post to use Winbond flash chips][ref-upy-forum-winbond-driver]\n\n\u003c!-- Links --\u003e\n[ref-rtd-micropython-winbond]: https://micropython-winbond.readthedocs.io/en/latest/\n[ref-remote-upy-shell]: https://github.com/dhylands/rshell\n[ref-brainelectronics-test-pypiserver]: https://github.com/brainelectronics/test-pypiserver\n[ref-crizeo]: https://forum.micropython.org/memberlist.php?mode=viewprofile\u0026u=3067\n[ref-upy-forum-winbond-driver]: https://forum.micropython.org/viewtopic.php?f=16\u0026t=3899\u0026start=10\n","funding_links":[],"categories":["Libraries"],"sub_categories":["Storage"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrainelectronics%2Fmicropython-winbond","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrainelectronics%2Fmicropython-winbond","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrainelectronics%2Fmicropython-winbond/lists"}