esltype¶
Version: v1 Scope: global (not tenant- or store-scoped) Owning service: studio-design-library
An esltype describes the hardware characteristics of a model of electronic shelf label: its screen resolution, physical dimensions, color capabilities, and whether it belongs to the "avenue" form-factor family. ESL type records are global — the same hardware model is the same regardless of which tenant or store uses it. The esltype_id field on storeesl points here, so renderers and designers know exactly what canvas size, palette, and aspect ratio to target when generating images for a specific physical device.
The color_space field was deprecated in minor version 1 in favour of palette_id, which references a structured palette resource and is more expressive for the e-ink display configurations supported by newer device families.
ID pattern¶
esltypes/{esltypeid}
esltypes/— global collection prefix; no tenant or store scope{esltypeid}— the platform-assigned identifier for this ESL hardware model
Schema¶
| Field | Type | Description |
|---|---|---|
id |
string |
Primary ID following the pattern esltypes/{esltypeid} |
numerical_id |
uint32 |
The numerical hardware model identifier used by PricerServer and device firmware. Example: 1317 |
display_name |
string |
Human-readable commercial name of the ESL type. Example: "Pricer Newton 2.2" |
width_pixels |
uint32 |
Horizontal screen resolution in pixels |
height_pixels |
uint32 |
Vertical screen resolution in pixels |
color_space |
ColorSpace (enum, deprecated) |
Color capabilities of the display. Superseded by palette_id |
palette_id |
string |
Palette resource representing the e-ink configuration. Example: "palettes/BWRY". Preferred over color_space |
is_avenue |
bool |
true if this type is an "avenue" form factor (tall, narrow label used for shelf-edge displays in certain store formats) |
diagonal_mm |
uint32 |
Display diagonal in millimeters |
diagonal_32nd_inch |
uint32 |
Display diagonal in 1/32nd-inch units |
total_width_mm |
uint32 |
Full device width in millimeters (including bezel) |
total_width_32nd_inch |
uint32 |
Full device width in 1/32nd-inch units |
total_height_mm |
uint32 |
Full device height in millimeters (including bezel) |
total_height_32nd_inch |
uint32 |
Full device height in 1/32nd-inch units |
resolution_dpi |
uint32 |
Screen resolution in dots per inch |
ColorSpace enum (deprecated)¶
| Value | Code | Description |
|---|---|---|
COLOR_SPACE_UNSPECIFIED |
0 | Default/unset |
BW |
1 | Black and white |
BWY |
2 | Black, white, yellow |
BWR |
3 | Black, white, red |
BWRY |
4 | Black, white, red, yellow |
The entire ColorSpace enum is marked deprecated = true. Use palette_id for new code.
Consumed by¶
| Service | Why |
|---|---|
studio-design-library |
Owns and serves esltype records; used as the authoritative source of device capabilities for design tooling |
studio-renderer |
Reads width_pixels, height_pixels, and palette_id (via the storeesl → esltype reference) to determine the render canvas and color constraints |
link-registry |
Stores esltype_id on storeesl records; uses esltype to validate that a device model is known before accepting a storeesl |