Skip to main content

py-reg-map

PyPI Python CI License: MIT

Register map generator for embedded firmware. A YAML file describes the device registers; regmap generates the C storage and Modbus RTU sources for the firmware (reg_map.h/.c, mb_rtu_app.h/.c) and the JSON definitions for the LeBin and Modbus RTU communication software.

Installation

Python 3.12 or newer. Install from PyPI:

pip install py-reg-map
pip install "py-reg-map[xlsx]"   # with Excel import

The latest development version comes straight from GitHub:

pip install "py-reg-map @ git+https://github.com/LogicElements/py-reg-map"

Usage

Start a new register map:

regmap init MyDevice                              # -> mydevice.yaml

Migrate an existing Excel register map (once):

regmap import-xlsx Documents/Vms1511.xlsm        # -> Documents/vms1511.yaml

Generate all outputs after editing the map, then commit them:

regmap generate Documents/vms1511.yaml
regmap generate Documents/vms1511.yaml --check              # CI: are the committed outputs current?
regmap generate Documents/vms1511.yaml --allow-id-change    # accept intended ID/Modbus changes

Editor completion for the YAML format:

regmap schema -o Documents/regmap.schema.json

Documentation

Start at doc/index.md: YAML format, command line, outputs and development guide.

License

MIT © 2026 Logic Elements s.r.o

Metadata

Release files for py-reg-map 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-reg-map 0.1.1
File Size Uploaded
py_reg_map-0.1.1.tar.gz 403.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for py-reg-map 0.1.1
File Interpreter ABI Platform
py_reg_map-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 442.3 kB

Release files / py_reg_map-0.1.1.tar.gz

Download URL py_reg_map-0.1.1.tar.gz
Size 403.1 kB
Tags Source
SHA-256 checksum
How to use checksums
0b1bc10183d0755d5992a9c82975b59b619625867c449165389dbaec310ce6af
BLAKE2b-256 checksum
How to use checksums
3bf7bb05231ce2667fb099e7c0c2b17a3ed495a74dec53920d5671d07759ad8f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / py_reg_map-0.1.1-py3-none-any.whl

Download URL py_reg_map-0.1.1-py3-none-any.whl
Size 39.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
048aa24cb71cce2bcbf91582999ffa0ca68d678ccf1803d3daa29edb8c116274
BLAKE2b-256 checksum
How to use checksums
7721ebd2a4b08631f5c3dae9b74c539fae5c75584d92baf166254861a485db29
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

0.2.0

2 release files

0.1.2

2 release files

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page