andry/EMS-ESP32
1
0
Fork 0
mirror of https://github.com/emsesp/EMS-ESP32.git synced 2026-01-26 08:39:09 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix show md compatible with docusaurus markup

Browse Source
This commit is contained in:
proddy
2025-12-29 16:34:01 +01:00
parent 535b760dd7
commit 1b4693b981
1 changed files with 35 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
scripts/generate-modbus-register-doc.py
View File

@@ -80,12 +80,40 @@ def group_entities_by_device_type(entities):
def print_device_entities(device_name, device_entities):
"""Print device entities table using f-strings for better performance."""
print(f"### {device_name}")
print()
print("| shortname | fullname | type | uom | writeable | tag type | register offset | register count | scale factor |")
print("|-|-|-|-|-|-|-|-|-|")
for entity in device_entities:
tag_type = get_tag_type(entity["modbus block"])
print(f"| {entity['shortname']} | {entity['fullname']} | {entity['type [options...] \\| (min/max)']} | "
type_long = entity['type [options...] \\| (min/max)']
# Split off type and the rest efficiently
split_type = type_long.split(" ", 1)
type_base = split_type[0]
type_suffix = split_type[1] if len(split_type) > 1 else ""
# Optimize type_rest extraction and int range detection
type_rest_str = type_suffix
if "int" in type_base and "(" in type_suffix:
try:
# Extract inner part of parentheses
range_inner = type_suffix[type_suffix.index("(")+1:type_suffix.index(")")]
min_value = max_value = None
if ">=" in range_inner and "<=" in range_inner:
# >=0<=100 style
min_value, max_value = range_inner.replace(">=", "").split("<=")
elif "/" in range_inner:
min_value, max_value = range_inner.split("/")
if min_value is not None and max_value is not None:
type_rest_str = f"(&gt;={min_value.strip()}&lt;={max_value.strip()})"
else:
type_rest_str = ""
except Exception:
# fallback to original
pass
print(f"| {entity['shortname']} | {entity['fullname']} | {type_base} {type_rest_str} | "
f"{entity['uom']} | {entity['writeable']} | {tag_type} | {entity['modbus offset']} | "
f"{entity['modbus count']} | {entity['modbus scale factor']} |")
print()
@@ -93,7 +121,8 @@ def print_device_entities(device_name, device_entities):
def print_device_type_devices(device_type, devices):
"""Print all devices of a specific type."""
print(f"## Devices of type *{device_type}*")
print(f"## Devices of type \\_{device_type}")
print()
# Group devices by name
device_groups = defaultdict(list)
@@ -106,18 +135,11 @@ def print_device_type_devices(device_type, devices):
def print_header():
"""Print the markdown document header."""
print("<!-- Use full browser width for this page, the tables are wide -->")
print("<style>")
print(".md-grid {")
print(" max-width: 100%; /* or 100%, if you want to stretch to full-width */")
print("}")
print("</style>")
print()
print("# Entity/Register Mapping")
print()
print("!!! note")
print("# Modbus Entity/Register Mapping")
print()
print(":::warning")
print("This file has been auto-generated. Do not modify.")
print(":::")
print()