Files
openhmi-nx/src/nxhmi/cli.py
T

195 lines
7.7 KiB
Python
Raw Normal View History

"""Command line interface: ``python -m nxhmi <command> ...``"""
from __future__ import annotations
import argparse
import json
import sys
from . import checksum, project
from .container import HMIFile
from .page import Page
def cmd_info(a):
h = HMIFile.load(a.hmi)
t0, t1 = h.table_ok()
print("file table: primary %s, backup %s" % ("ok" if t0 else "BAD", "ok" if t1 else "BAD"))
for e in h.entries:
flag = "deleted" if e.deleted else ""
shown = e.name if not e.deleted else "(%s)" % e.name.encode("latin-1").decode("ascii", "replace").replace("�", "?").replace("\0", "?")
line = "%-16s %8d bytes @0x%07X %s" % (shown, e.size, e.start, flag)
if not e.deleted and e.name.endswith(".pa"):
blob = h.read(e.name)
ok = checksum.page_crc(blob) == int.from_bytes(blob[:4], "little")
p = Page.parse(blob, verify=False)
line += " page %-14s %3d components crc %s" % (p.name, len(p.components), "ok" if ok else "BAD")
print(line)
def cmd_verify(a):
bad = 0
for path in a.hmi:
h = HMIFile.load(path)
for e in h.live():
blob = h.read(e.name)
stored = int.from_bytes(blob[:4], "little")
if e.name.endswith(".pa") and checksum.page_crc(blob) != stored:
print("%s: %s page checksum BAD" % (path, e.name)); bad += 1
if e.name == "main.HMI" and checksum.main_crc(blob) != stored:
print("%s: main.HMI checksum BAD" % path); bad += 1
t0, t1 = h.table_ok()
if not (t0 and t1):
print("%s: file table checksum BAD (primary %s, backup %s)" % (path, t0, t1)); bad += 1
if not bad:
print("%s: ok" % path)
return 1 if bad else 0
def cmd_decode(a):
m = project.decode(a.hmi, a.out, a.encoding, not a.raw)
print("decoded %d entries into %s" % (len(m["entries"]), a.out))
def cmd_encode(a):
project.encode(a.folder, a.hmi)
print("wrote", a.hmi)
def cmd_set(a):
"""Set one attribute in place: nxhmi set file.HMI page objname attr value [-o out]"""
h = HMIFile.load(a.hmi)
for e in h.live():
if not e.name.endswith(".pa"):
continue
p = Page.parse(h.read(e.name))
if p.name != a.page:
continue
c = p.component(a.component)
if c is None:
sys.exit("no component %r on page %r" % (a.component, a.page))
kind, _ = c.attr(a.attr).decoded()
c.set(a.attr, a.value if kind in ("str", "hex") else int(a.value, 0))
h.write(e.name, p.pack())
h.save(a.out or a.hmi)
print("set %s.%s.%s = %s" % (a.page, a.component, a.attr, a.value))
return
sys.exit("no page %r" % a.page)
def cmd_add(a):
"""Add a component: nxhmi add file.HMI page kind [name=value ...] [--name obj] [-o out]"""
from . import components
h = HMIFile.load(a.hmi)
for e in h.live():
if not e.name.endswith(".pa"):
continue
p = Page.parse(h.read(e.name))
if p.name != a.page:
continue
kw = {}
for item in a.attrs:
k, _, v = item.partition("=")
try:
kw[k] = int(v, 0)
except ValueError:
kw[k] = v
c = components.add(p, a.kind, a.name, **kw)
h.write(e.name, p.pack())
h.save(a.out or a.hmi)
print("added %s (%s, id %d) to page %s" % (c.name, a.kind, c.get("id"), p.name))
return
sys.exit("no page %r" % a.page)
def cmd_new_page(a):
from . import project
h = HMIFile.load(a.hmi)
project.add_page(h, a.name)
h.save(a.out or a.hmi)
print("added page", a.name)
def cmd_add_font(a):
from . import fonts, project
h = HMIFile.load(a.hmi)
f = fonts.from_ttf(a.ttf, a.height, a.encoding, a.fixed_width)
fid = project.add_font(h, f)
h.save(a.out or a.hmi)
print("added font id %d (%s, %d chars)" % (fid, f.name, len(f.glyphs)))
def cmd_add_picture(a):
from . import project
h = HMIFile.load(a.hmi)
with open(a.image, "rb") as f:
pid = project.add_picture(h, f.read())
h.save(a.out or a.hmi)
print("added picture id", pid)
def cmd_render(a):
import os
from .render import Renderer
r = Renderer(HMIFile.load(a.hmi))
names = [k for k in r.pages if isinstance(k, str)]
todo = names if a.page in (None, "all") else [a.page]
os.makedirs(a.out, exist_ok=True)
for n in todo:
path = os.path.join(a.out, "%s.png" % n)
r.render(n).save(path)
print("wrote", path)
def cmd_kinds(a):
from . import components
for k in components.kinds():
print(k)
def cmd_dump(a):
h = HMIFile.load(a.hmi)
for e in h.live():
if e.name.endswith(".pa"):
p = Page.parse(h.read(e.name))
if a.page and p.name != a.page:
continue
print(json.dumps(project.page_to_json(e.name, p, a.encoding, not a.raw), indent=1, ensure_ascii=False))
def main(argv=None):
ap = argparse.ArgumentParser(prog="nxhmi", description="Read, verify and write Nextion Editor .HMI projects")
sub = ap.add_subparsers(dest="cmd", required=True)
s = sub.add_parser("info", help="list entries, pages and checksum status"); s.add_argument("hmi"); s.set_defaults(f=cmd_info)
s = sub.add_parser("verify", help="check every checksum"); s.add_argument("hmi", nargs="+"); s.set_defaults(f=cmd_verify)
s = sub.add_parser("decode", help="HMI -> folder of JSON/text"); s.add_argument("hmi"); s.add_argument("out")
s.add_argument("--encoding", default="latin-1"); s.add_argument("--raw", action="store_true", help="numbers instead of names/colours")
s.set_defaults(f=cmd_decode)
s = sub.add_parser("encode", help="folder -> new HMI"); s.add_argument("folder"); s.add_argument("hmi"); s.set_defaults(f=cmd_encode)
s = sub.add_parser("set", help="change one attribute")
for n in ("hmi", "page", "component", "attr", "value"):
s.add_argument(n)
s.add_argument("-o", "--out"); s.set_defaults(f=cmd_set)
s = sub.add_parser("add", help="add a component to a page (kind: see 'kinds')")
s.add_argument("hmi"); s.add_argument("page"); s.add_argument("kind")
s.add_argument("attrs", nargs="*", help="attribute=value, e.g. x=10 y=20 txt=Hi")
s.add_argument("--name"); s.add_argument("-o", "--out"); s.set_defaults(f=cmd_add)
s = sub.add_parser("render", help="render pages to PNG like the Editor's canvas (needs Pillow)")
s.add_argument("hmi"); s.add_argument("out", help="output folder"); s.add_argument("--page", help="page name (default: all)")
s.set_defaults(f=cmd_render)
s = sub.add_parser("kinds", help="list component kinds that can be added"); s.set_defaults(f=cmd_kinds)
s = sub.add_parser("add-font", help="rasterize a .ttf into a new font (needs Pillow)")
s.add_argument("hmi"); s.add_argument("ttf"); s.add_argument("height", type=int)
s.add_argument("--encoding", default="ascii", choices=["ascii", "iso-8859-1"])
s.add_argument("--fixed-width", type=int); s.add_argument("-o", "--out"); s.set_defaults(f=cmd_add_font)
s = sub.add_parser("add-picture", help="add a picture (png/jpg/bmp; needs Pillow)")
s.add_argument("hmi"); s.add_argument("image"); s.add_argument("-o", "--out"); s.set_defaults(f=cmd_add_picture)
s = sub.add_parser("new-page", help="add an empty page"); s.add_argument("hmi"); s.add_argument("name")
s.add_argument("-o", "--out"); s.set_defaults(f=cmd_new_page)
s = sub.add_parser("dump", help="print pages as JSON"); s.add_argument("hmi"); s.add_argument("--page")
s.add_argument("--encoding", default="latin-1"); s.add_argument("--raw", action="store_true"); s.set_defaults(f=cmd_dump)
a = ap.parse_args(argv)
return a.f(a) or 0
if __name__ == "__main__":
sys.exit(main())