esldriver
Version: v1
Scope: global (singleton per ESL type; not tenant- or store-scoped)
Owning service: studio-design-library
The esldriver DTO records rendering-specific driver configuration for a given ESL hardware type. Currently it carries the physical display rotation: many device models mount the e-ink panel sideways or upside-down relative to the device's external orientation, so the renderer must rotate the image by the declared amount before transmitting it to the device. The driver record is a singleton companion to the esltype: every esltype that requires non-zero rotation has exactly one esldriver keyed under it.
ID pattern
esltypes/{esltypeid}/driver
esltypes/{esltypeid} — the parent esltype this driver applies to/driver — singleton suffix; one driver record per ESL type
Schema
| Field |
Type |
Description |
id |
string |
Primary ID following the pattern esltypes/{esltypeid}/driver |
rendering |
Rendering |
Rendering-specific configuration for this device type |
Rendering message
| Field |
Type |
Description |
display_rotation |
Rotation (enum) |
The rotation applied to the display panel as it is physically mounted inside the device housing |
Rotation enum
| Value |
Code |
Description |
NONE |
0 |
No rotation; the panel is mounted in the natural orientation |
CW_90 |
1 |
90 degrees clockwise |
CW_180 |
2 |
180 degrees clockwise (upside-down) |
CW_270 |
3 |
270 degrees clockwise (equivalent to 90 degrees counter-clockwise) |
Consumed by
| Service |
Why |
studio-renderer |
Reads display_rotation to apply the correct image rotation before sending the rendered bitmap to the device; without this the image would appear sideways or inverted on hardware with non-standard panel mounting |
studio-design-library |
Owns and serves esldriver records alongside the esltype catalogue |
- esltype — the parent ESL type record this driver belongs to; provides resolution, palette, and physical dimensions