# MyEVSE Webinterface
[](https://pepy.tech/project/myevse-webinterface)
[](https://opensource.org/licenses/MIT)
MicroPython based Webinterface of MyEVSE
---------------
## General
This is the webinterface of the MyEVSE
<a href="https://www.tindie.com/stores/brainelectronics/?ref=offsite_badges&utm_source=sellers_brainelectronics&utm_medium=badges&utm_campaign=badge_medium"><img src="https://d2ss6ovg47m0r5.cloudfront.net/badges/tindie-mediums.png" alt="I sell on Tindie" width="150" height="78"></a>
The current implementation does only run on a board with external SPI RAM. As
of now up to 300kB of RAM are required. This is more than an ESP32-D4 Pico
provides by default.
📚 The latest documentation is available at
[MyEVSE Webinterface ReadTheDocs][ref-rtd-myevse-webinterface] 📚
<!-- MarkdownTOC -->
- [Quickstart](#quickstart)
- [Install package on board with mip or upip](#install-package-on-board-with-mip-or-upip)
- [Upload additional files to board](#upload-additional-files-to-board)
- [Usage](#usage)
<!-- /MarkdownTOC -->
## Quickstart
This is a quickstart to install the `myevse-webinterface` library on a
MicroPython board.
A more detailed guide of the development environment can be found in
[SETUP](SETUP.md), further details about the usage can be found in
[USAGE](USAGE.md), descriptions for testing can be found in
[TESTING](TESTING.md) and several examples in [EXAMPLES](EXAMPLES.md)
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
### Install package on board with mip or upip
```bash
rshell -p /dev/tty.SLAB_USBtoUART --editor nano
```
Inside the [rshell][ref-remote-upy-shell] open a REPL and execute these
commands inside the REPL
```python
import machine
import network
import time
import mip
station = network.WLAN(network.STA_IF)
station.active(True)
station.connect('SSID', 'PASSWORD')
time.sleep(1)
print('Device connected to network: {}'.format(station.isconnected()))
mip.install('myevse-webinterface', index='https://pypi.org/pypi')
print('Installation completed')
machine.soft_reset()
```
For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`
```python
import machine
import network
import time
import upip
station = network.WLAN(network.STA_IF)
station.active(True)
station.connect('SSID', 'PASSWORD')
time.sleep(1)
print('Device connected to network: {}'.format(station.isconnected()))
upip.install('myevse-webinterface')
print('Installation completed')
machine.soft_reset()
```
### Upload additional files to board
Copy the [`boot.py`](boot.py) and [`main.py`](main.py) files to the
MicroPython board 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 -p /dev/tty.SLAB_USBtoUART --editor nano
```
Perform the following command to copy all files to the device
```bash
cp main.py /pyboard
cp boot.py /pyboard
```
## Usage
See [USAGE](USAGE.md) and [DOCUMENTATION](DOCUMENTATION.md)
<!-- Links -->
[ref-rtd-myevse-webinterface]: https://myevse-webinterface.readthedocs.io/en/latest/
[ref-upy-firmware-download]: https://micropython.org/download/
[ref-remote-upy-shell]: https://github.com/dhylands/rshell
[ref-myevse-be]: https://brainelectronics.de/
[ref-myevse-tindie]: https://www.tindie.com/stores/brainelectronics/
Raw data
{
"_id": null,
"home_page": "https://github.com/brainelectronics/MyEVSE-Webinterface",
"name": "myevse-webinterface",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "micropython,brainelectronics,wifi,modbus,myevse",
"author": "brainelectronics",
"author_email": "info@brainelectronics.de",
"download_url": "https://files.pythonhosted.org/packages/3d/25/9ea255217c477205b2cc76112867311d1d039f2b2976841187add7f5248e/myevse-webinterface-0.9.1.tar.gz",
"platform": null,
"description": "# MyEVSE Webinterface\n\n[](https://pepy.tech/project/myevse-webinterface)\n\n\n[](https://opensource.org/licenses/MIT)\n\nMicroPython based Webinterface of MyEVSE\n\n---------------\n\n## General\n\nThis is the webinterface of the MyEVSE\n\n<a href=\"https://www.tindie.com/stores/brainelectronics/?ref=offsite_badges&utm_source=sellers_brainelectronics&utm_medium=badges&utm_campaign=badge_medium\"><img src=\"https://d2ss6ovg47m0r5.cloudfront.net/badges/tindie-mediums.png\" alt=\"I sell on Tindie\" width=\"150\" height=\"78\"></a>\n\nThe current implementation does only run on a board with external SPI RAM. As\nof now up to 300kB of RAM are required. This is more than an ESP32-D4 Pico\nprovides by default.\n\n\ud83d\udcda The latest documentation is available at\n[MyEVSE Webinterface ReadTheDocs][ref-rtd-myevse-webinterface] \ud83d\udcda\n\n<!-- MarkdownTOC -->\n\n- [Quickstart](#quickstart)\n\t- [Install package on board with mip or upip](#install-package-on-board-with-mip-or-upip)\n\t- [Upload additional files to board](#upload-additional-files-to-board)\n- [Usage](#usage)\n\n<!-- /MarkdownTOC -->\n\n## Quickstart\n\nThis is a quickstart to install the `myevse-webinterface` library on a\nMicroPython board.\n\nA more detailed guide of the development environment can be found in\n[SETUP](SETUP.md), further details about the usage can be found in\n[USAGE](USAGE.md), descriptions for testing can be found in\n[TESTING](TESTING.md) and several examples in [EXAMPLES](EXAMPLES.md)\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\n\npip install -r requirements.txt\n```\n\n### Install package on board with mip or upip\n\n```bash\nrshell -p /dev/tty.SLAB_USBtoUART --editor nano\n```\n\nInside the [rshell][ref-remote-upy-shell] open a REPL and execute these\ncommands inside the REPL\n\n```python\nimport machine\nimport network\nimport time\nimport mip\nstation = network.WLAN(network.STA_IF)\nstation.active(True)\nstation.connect('SSID', 'PASSWORD')\ntime.sleep(1)\nprint('Device connected to network: {}'.format(station.isconnected()))\nmip.install('myevse-webinterface', index='https://pypi.org/pypi')\nprint('Installation completed')\nmachine.soft_reset()\n```\n\nFor MicroPython versions below 1.19.1 use the `upip` package instead of `mip`\n\n```python\nimport machine\nimport network\nimport time\nimport upip\nstation = network.WLAN(network.STA_IF)\nstation.active(True)\nstation.connect('SSID', 'PASSWORD')\ntime.sleep(1)\nprint('Device connected to network: {}'.format(station.isconnected()))\nupip.install('myevse-webinterface')\nprint('Installation completed')\nmachine.soft_reset()\n```\n\n### Upload additional files to board\n\nCopy the [`boot.py`](boot.py) and [`main.py`](main.py) files to the\nMicroPython board as shown below using\n[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 to copy all files to the device\n\n```bash\ncp main.py /pyboard\ncp boot.py /pyboard\n```\n\n## Usage\n\nSee [USAGE](USAGE.md) and [DOCUMENTATION](DOCUMENTATION.md)\n\n<!-- Links -->\n[ref-rtd-myevse-webinterface]: https://myevse-webinterface.readthedocs.io/en/latest/\n[ref-upy-firmware-download]: https://micropython.org/download/\n[ref-remote-upy-shell]: https://github.com/dhylands/rshell\n[ref-myevse-be]: https://brainelectronics.de/\n[ref-myevse-tindie]: https://www.tindie.com/stores/brainelectronics/\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MyEVSE Webinterface based on MicroPython",
"version": "0.9.1",
"split_keywords": [
"micropython",
"brainelectronics",
"wifi",
"modbus",
"myevse"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d259ea255217c477205b2cc76112867311d1d039f2b2976841187add7f5248e",
"md5": "42a25cf45e4adb42f731d363c55318a5",
"sha256": "f92dae7ef7c22766a5a037210efe3a8b81c5f3b771ff0d1ae4f89cf8eca9a3a6"
},
"downloads": -1,
"filename": "myevse-webinterface-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "42a25cf45e4adb42f731d363c55318a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22579,
"upload_time": "2023-02-01T21:34:11",
"upload_time_iso_8601": "2023-02-01T21:34:11.055832Z",
"url": "https://files.pythonhosted.org/packages/3d/25/9ea255217c477205b2cc76112867311d1d039f2b2976841187add7f5248e/myevse-webinterface-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-01 21:34:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "brainelectronics",
"github_project": "MyEVSE-Webinterface",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "myevse-webinterface"
}
JSON
