{
  "id": "brainelectronics/micropython-winbond",
  "name": "micropython-winbond",
  "prettyName": "micropython-winbond",
  "description": "Micropython library to interact with Winbond Flash chips",
  "version": "",
  "author": "brainelectronics",
  "license": "MIT",
  "tags": [
    "flash",
    "library",
    "micropython",
    "micropython-lib",
    "winbond"
  ],
  "status": "VALID",
  "official": false,
  "source": "https://github.com/brainelectronics/micropython-winbond",
  "updatedAt": "2025-06-28T06:59:59.045Z",
  "page": "https://checkmim.com/packages/brainelectronics+micropython-winbond",
  "createdAt": "2025-05-27T04:35:43.815Z",
  "submittedBy": "oliverr",
  "install": {
    "mpremote": "mpremote mip install github:brainelectronics/micropython-winbond",
    "mip": "import mip; mip.install(\"github:brainelectronics/micropython-winbond\")"
  },
  "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&color=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<!-- MarkdownTOC -->\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<!-- /MarkdownTOC -->\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<!-- Links -->\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&u=3067\n[ref-upy-forum-winbond-driver]: https://forum.micropython.org/viewtopic.php?f=16&t=3899&start=10\n"
}