# MicroPython Nextion library
[](https://pepy.tech/project/micropython-nextion)
[](https://opensource.org/licenses/MIT)
MicroPython Nextion library
---------------
## General
Ported library to interact with [Nextion serial displays][ref-nextion-wiki],
based on the [ITEAD Arduino Nextion][ref-itead-nextion-github] library.
## Installation
### Install required tools
Python3 must be installed on your system. Check the current Python version
with the following command
```bash
python --version
python3 --version
```
Depending on which command `Python 3.x.y` (with x.y as some numbers) is
returned, use that command to proceed.
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
## Setup
### Install package with upip
Connect the MicroPython device to a network (if possible)
```python
import network
station = network.WLAN(network.STA_IF)
station.active(True)
station.connect('SSID', 'PASSWORD')
station.isconnected()
```
#### General
Install the latest package version of this lib on the MicroPython device
```python
import mip
mip.install("github:brainelectronics/micropython-nextion")
```
For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`
```python
import upip
upip.install('micropython-nextion')
```
#### Specific version
Install a specific, fixed package version of this lib on the MicroPython device
```python
import mip
# install a verions of a specific branch
mip.install("github:brainelectronics/micropython-nextion", version="feature/add-mip-package-file")
# install a tag version
mip.install("github:brainelectronics/micropython-nextion", version="0.15.0")
```
For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`
```python
import upip
upip.install('micropython-nextion')
```
#### Test version
Install a specific release candidate version uploaded to
[Test Python Package Index](https://test.pypi.org/) on every PR on the
MicroPython device. If no specific version is set, the latest stable version
will be used.
```python
import mip
mip.install("github:brainelectronics/micropython-nextion", version="0.15.0-rc1.dev29")
```
For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`
```python
import upip
# overwrite index_urls to only take artifacts from test.pypi.org
upip.index_urls = ['https://test.pypi.org/pypi']
upip.install('micropython-nextion')
```
See also [brainelectronics Test PyPi Server in Docker][ref-brainelectronics-test-pypiserver]
for a test PyPi server running on Docker.
### Manually
#### Upload files to board
Copy the module to the MicroPython board and import them as shown below
using [Remote MicroPython shell][ref-remote-upy-shell]
Open the remote shell with the following command. Additionally use `-b 115200`
in case no CP210x is used but a CH34x.
```bash
rshell --port /dev/tty.SLAB_USBtoUART --editor nano
```
Perform the following command inside the `rshell` to copy all files and
folders to the device
```bash
mkdir /pyboard/lib
mkdir /pyboard/lib/nextion
cp nextion/* /pyboard/lib/nextion
cp examples/basic/main.py /pyboard
cp examples/boot.py /pyboard
```
## Usage
Use one of the [examples](examples/) to get started. Read also the
[examples README](examples/README.md) to find all supported elements
## Credits
Big thank you to [ITEAD Studio][ref-itead-github] for the implementation
of the Arduino library.
<!-- Links -->
[ref-nextion-wiki]: https://wiki.iteadstudio.com/Nextion_HMI_Solution
[ref-itead-nextion-github]: https://github.com/itead/ITEADLIB_Arduino_Nextion
[ref-remote-upy-shell]: https://github.com/dhylands/rshell
[ref-brainelectronics-test-pypiserver]: https://github.com/brainelectronics/test-pypiserver
[ref-github-be-mircopython-modules]: https://github.com/brainelectronics/micropython-modules
[ref-itead-github]: https://github.com/itead
Raw data
{
"_id": null,
"home_page": "https://github.com/brainelectronics/micropython-nextion",
"name": "micropython-nextion",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "micropython,nextion,display,nextion-display,nextion-communication,uart,library",
"author": "brainelectronics",
"author_email": "info@brainelectronics.de",
"download_url": "https://files.pythonhosted.org/packages/fe/2b/602ec5dbababd630fd5f4c9c0d348478b854b578b3971f721d150082c5de/micropython-nextion-0.15.3.tar.gz",
"platform": null,
"description": "# MicroPython Nextion library\n\n[](https://pepy.tech/project/micropython-nextion)\n\n\n[](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 with upip\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\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MicroPython Nextion serial displays library",
"version": "0.15.3",
"project_urls": {
"Bug Reports": "https://github.com/brainelectronics/micropython-nextion/issues",
"Homepage": "https://github.com/brainelectronics/micropython-nextion",
"Source": "https://github.com/brainelectronics/micropython-nextion"
},
"split_keywords": [
"micropython",
"nextion",
"display",
"nextion-display",
"nextion-communication",
"uart",
"library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe2b602ec5dbababd630fd5f4c9c0d348478b854b578b3971f721d150082c5de",
"md5": "20149509583583ac49e169c163cbb81d",
"sha256": "2b5ca9b682419948ba4ae863bd4db7245ac71a0fb493bc46da79b13776771ac5"
},
"downloads": -1,
"filename": "micropython-nextion-0.15.3.tar.gz",
"has_sig": false,
"md5_digest": "20149509583583ac49e169c163cbb81d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19166,
"upload_time": "2023-05-17T06:14:15",
"upload_time_iso_8601": "2023-05-17T06:14:15.638272Z",
"url": "https://files.pythonhosted.org/packages/fe/2b/602ec5dbababd630fd5f4c9c0d348478b854b578b3971f721d150082c5de/micropython-nextion-0.15.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-17 06:14:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brainelectronics",
"github_project": "micropython-nextion",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "micropython-nextion"
}
JSON
