Skip to content

ecceslimage

Version: v1 Scope: per-tenant+store (one per ESL page) Owning service: ecc-image-render-service

The ecceslimage is the rendered page image produced by the ECC rendering pipeline for an ESL page. ecc-image-render-service writes this DTO after rendering a model against item data from an EccSingle or MultiItem link variant. The image is stored in LFS; the DTO records the file path and required display rotation.

Like studioeslimage, ecceslimage is an intermediate DTO. eslimage-merger reads it alongside studioeslimage and writes the final eslimage that gets delivered to hardware. At most one of ecceslimage and studioeslimage is active for a given ESL page at any time: the active path is determined by the current link variant.

When a by_storeesl link deletion notification arrives, ecc-image-render-service deletes the ecceslimage record to prevent stale images from remaining in the system after a link is removed.

ID pattern

t/{tenantid}/s/{storeid}/esls/{barcode}/pages/{pagenum}/eccimage

  • t/{tenantid} — tenant namespace
  • s/{storeid} — store within the tenant
  • esls/{barcode} — the ESL's barcode
  • pages/{pagenum} — zero-based page index
  • eccimage — fixed terminal segment distinguishing this from the studio-path sibling studioimage

Schema

Field Type Description
id string Primary ID following the pattern above
file_path string LFS path to the rendered PNG. Format: renderer/t/{tenantid}/eslimages/{SHA256}.png. Content-addressed by SHA-256 hash of file contents
rotation Rotation Display rotation to be applied when the image is shown on the ESL hardware

Rotation enum

Value Description
NONE (0) No rotation
CW_90 (1) 90 degrees clockwise
CW_180 (2) 180 degrees clockwise
CW_270 (3) 270 degrees clockwise

Consumed by

Service Why
eslimage-merger Subscribes to ecceslimage.v1; when a new ecceslimage arrives (or the competing studioeslimage is deleted), the merger writes or updates the final eslimage
  • eslimage — the final merged image that eslimage-merger produces from this DTO
  • studioeslimage — the competing studio-path image for the same ESL page; at most one of ecceslimage / studioeslimage is populated at any time
  • eccmodel — the ECC device model definition used during rendering; referenced by the EccSingle or MultiItem link variant
  • eccparameters — singleton per-store global parameters (including IPF entries) available during ECC rendering
  • storeesl — the ESL registration record providing hardware type context