Skip to main content

Simple environment variable loader for MicroPython board.

Project description

micropython-env

Simple environment variable loader for MicroPython board.

The loader could load environment variables from the one of file format as below:

  • JSON (default) : The file name is "env.json" (text mode).
  • MessagePack: The file name is "env" or "env.msgpack" (binary mode).

How to Use

from mpy_env import load_env, get_env, put_env

# Loading `env.json` at once as default.
# You can invoke below function in `boot.py`
load_env()
# or
load_env(0)

# You can loading environment variables from MessagePack as below.
load_env(1)

# In `main.py` or the other,
# You can invoke below function to get environment variable.
get_env('key')

# You can invoke below function to set environment variable in-memory.
put_env('tuple', ('a', 1))

Testing

Currentl testing environment:

  • Python 3.7
  • MicroPython 1.12 (unix port & esp32 port)

Before tesing, you need to compile Micopython unix port executable first, see offcial GitHub Wiki.

We use mpfshell to interactive with MicroPython board, please install the latest release from PyPi.

pip install mpfshell

We use offcial MessagePack package to validate custom msgpack module, please install the latest release from PyPi.

pip install msgpack

Next, clone the repository to your local machine.

git clone https://github.com/ShenTengTu/micropython-env.git
cd micropython-env

To test on Python & MicroPython unix port, execute the command as below.

make testing

Before testing on the board, you need upload files first.

Connect the board to PC, execute the command as below to clean up the file system first:

make mpy-clean

Then install mpy_env package and upload testing files to the board :

make mpy-install
make mpy-put-test

Open mpfshell prompt and enter REPL:

make mpy-open
...
mpfs>  repl

Execute testing scripts as below:

MicroPython v1.12 on 2019-12-20; ESP32 module with ESP32
Type "help()" for more information.
>>> import test_msgpack
...
>>> import test_mpy_env
...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

micropython-mpy-env-0.1.0.tar.gz (5.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page