Skip to content

eslimage

Version: v1 Scope: per-tenant+store (one per ESL page) Owning service: eslimage-merger

The eslimage is the final, authoritative rendered page image for a physical ESL. It is produced by eslimage-merger, which combines the output of the two renderer pipelines: studioeslimage (from studio-renderer) and ecceslimage (from ecc-image-render-service). Exactly one of those two upstream images will be present for any given ESL page at any point in time, depending on which link variant is active — Single routes to the studio pipeline and EccSingle/MultiItem routes to the ECC pipeline. The merger selects whichever upstream image is current and writes it here.

eslimage is the DTO that downstream hardware delivery reads. pricer-server subscribes to eslimage.v1 and pushes the image file referenced by file_path to the physical ESL device.

This DTO was introduced as part of PLT-2487, which retired the dual-write race condition that existed in the legacy renderedimage DTO. New consumers must use eslimage; see renderedimage for migration details.

ID pattern

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

  • t/{tenantid} — tenant namespace
  • s/{storeid} — store within the tenant
  • esls/{barcode} — the ESL's barcode (MAC address or hardware serial)
  • pages/{pagenum} — zero-based page index on the ESL display; most ESLs have a single page (pages/0)
  • image — fixed terminal segment; one eslimage record per page per ESL

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. The filename is the SHA-256 hash of the file content, enabling content-addressed deduplication across stores
rotation Rotation Physical rotation that must be applied when displaying the image on the ESL hardware

Rotation enum

Value Description
NONE (0) Image is displayed upright; no rotation applied
CW_90 (1) Image is rotated 90 degrees clockwise
CW_180 (2) Image is rotated 180 degrees clockwise
CW_270 (3) Image is rotated 270 degrees clockwise

Consumed by

Service Why
pricer-server Subscribes to eslimage.v1; reads file_path from LFS and pushes the image bytes to the physical ESL hardware
  • studioeslimage — upstream image produced by studio-renderer; one of the two inputs that eslimage-merger consumes
  • ecceslimage — upstream image produced by ecc-image-render-service; the other merger input
  • renderedimage — legacy predecessor to eslimage; deprecated, kept for migration compatibility only
  • storeesl — the ESL registration record; provides esltype_id and department context for the ESL this image belongs to