nxhmi.qr is a dependency-free QR encoder. Measured in the Editor simulator: numeric/alphanumeric/byte mode by content, level L, mask 0, smallest version; scaled to w - 2*dis by width (not clipped to h), last column run one pixel narrower, logo centred, nothing when too small. Basic rendering is now 20/20 pixel-exact. Also: unknown component kinds give a clean CLI error instead of a traceback. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2.9 KiB
2.9 KiB
name, description
| name | description |
|---|---|
| nextion-hmi | Create, inspect, edit and render Nextion display projects (.HMI files) without Nextion Editor, using the nxhmi tools in this repo. Use when the user wants to build or change a Nextion screen, page, button, text, slider, picture or font, look at how a page looks, or check an .HMI file. |
Working on Nextion .HMI projects
Prefer the nxhmi MCP tools (configured in .mcp.json); fall back to the CLI
(PYTHONPATH=src python -m nxhmi ...) or the Python API (src/nxhmi) when they are not available.
Loop
info-- model, display size, pages, components, pictures, fonts.get_page-- the components of one page with readable values.- Change things:
set_attributes,set_event,add_component,remove_component,add_page,add_picture,add_font. Every call saves the file. verify-- all checksums must be ok.render_page-- look at the result (it matches Nextion Editor's canvas) before telling the user it is done. Fix overlaps, clipped text and wrong colours you see.
Back up the user's file first (copy it) unless they said not to; edits write in place.
Values
- Attributes accept readable values:
xcen/ycenleft|center|right/up|center|down,stacrop image|solid color|image(page:no background|solid color|image),styleflat|border|3D_Down|3D_Up(+3D_Autofor buttons), colours as#rrggbb(stored as RGB565, so they snap to the nearest 5/6/5-bit colour). Numbers always work too. schema <kind>lists every attribute of a component kind with defaults and allowed values;list_kindslists the kinds (button,text,number,slider,progress_bar, ...).- Coordinates:
x,y,w,hin pixels;endx/endyare updated automatically. - Text needs a font:
fontis a font id. A new project has no fonts -- calladd_fontfirst (height in px; no TrueType path = bundled CC0 font).txt_maxlmust be >= the text length. - Pictures:
add_picturereturns an id forpic/picc(crop) /pic2etc. Basic-series displays only (Intelligent compressed pictures are not supported yet). - Event code is Nextion script, one line per list item, e.g.
["page settings"],["n0.val++", "t0.txt=\"hi\""]. Events:codesdown(press),codesup(release),codesload/codesloadend(page pre/post-initialize),codesunload,codestimer,codesslide. objnamemust be unique per page;add_componentpicksb0,t1, ... if no name is given.
Limits (see docs/COVERAGE.md)
- Writes projects for Nextion Editor 1.68.2; the user still compiles/uploads the
.tftwith the Editor (or Nexus for uploading). nxhmi cannot compile.tftfiles yet. - Rendering: Intelligent-only components are not drawn yet.
- QR codes on Basic displays: long texts can exceed the display RAM; the Editor then refuses to compile ("not enough memory ... QR code"). Keep QR texts short there and compile to check.