{
  "id": "brainelectronics/micropython-nextion",
  "name": "micropython-nextion",
  "prettyName": "micropython-nextion",
  "description": "Control Nextion displays using MicroPython",
  "version": "",
  "author": "brainelectronics",
  "license": "MIT",
  "tags": [
    "display",
    "hmi",
    "hmi-tft",
    "library",
    "micropython",
    "micropython-lib",
    "nextion",
    "nextion-communication",
    "nextion-display",
    "serial",
    "uart"
  ],
  "status": "VALID",
  "official": false,
  "source": "https://github.com/brainelectronics/micropython-nextion",
  "updatedAt": "2026-06-29T06:59:57.190Z",
  "page": "https://checkmim.com/packages/brainelectronics+micropython-nextion",
  "createdAt": "2025-05-27T04:33:16.221Z",
  "submittedBy": "oliverr",
  "install": {
    "mpremote": "mpremote mip install github:brainelectronics/micropython-nextion",
    "mip": "import mip; mip.install(\"github:brainelectronics/micropython-nextion\")"
  },
  "readme": "# MicroPython Nextion library\n\n[![Downloads](https://pepy.tech/badge/micropython-nextion)](https://pepy.tech/project/micropython-nextion)\n![Release](https://img.shields.io/github/v/release/brainelectronics/micropython-nextion?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\nMicroPython Nextion library\n\n---------------\n\n## General\n\nPorted library to interact with [Nextion serial displays][ref-nextion-wiki],\nbased on the [ITEAD Arduino Nextion][ref-itead-nextion-github] library.\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\n## Setup\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-nextion\")\n```\n\nFor MicroPython versions below 1.19.1 use the `upip` package instead of `mip`\n\n```python\nimport upip\nupip.install('micropython-nextion')\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-nextion\", version=\"feature/add-mip-package-file\")\n# install a tag version\nmip.install(\"github:brainelectronics/micropython-nextion\", version=\"0.15.0\")\n```\n\nFor MicroPython versions below 1.19.1 use the `upip` package instead of `mip`\n\n```python\nimport upip\nupip.install('micropython-nextion')\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-nextion\", version=\"0.15.0-rc1.dev29\")\n```\n\nFor MicroPython versions below 1.19.1 use the `upip` package instead of `mip`\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-nextion')\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 --port /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/nextion\n\ncp nextion/* /pyboard/lib/nextion\n\ncp examples/basic/main.py /pyboard\ncp examples/boot.py /pyboard\n```\n\n## Usage\n\nUse one of the [examples](examples/) to get started. Read also the\n[examples README](examples/README.md) to find all supported elements\n\n## Credits\n\nBig thank you to [ITEAD Studio][ref-itead-github] for the implementation\nof the Arduino library.\n\n<!-- Links -->\n[ref-nextion-wiki]: https://wiki.iteadstudio.com/Nextion_HMI_Solution\n[ref-itead-nextion-github]: https://github.com/itead/ITEADLIB_Arduino_Nextion\n[ref-remote-upy-shell]: https://github.com/dhylands/rshell\n[ref-brainelectronics-test-pypiserver]: https://github.com/brainelectronics/test-pypiserver\n[ref-github-be-mircopython-modules]: https://github.com/brainelectronics/micropython-modules\n[ref-itead-github]: https://github.com/itead\n"
}