Software Reference Manual 9.2.2
Library for Pervasive Displays e-paper screens, extension boards and development kits
Macros
hV_List_Constants.h File Reference

List of constants for Pervasive Displays Library Suite. More...

#include "stdint.h"
Include dependency graph for hV_List_Constants.h:
This graph shows which files directly or indirectly include this file:

Macros

#define hV_LIST_CONSTANTS_RELEASE   902
 Release.
 
#define eScreen_EPD_t   uint32_t
 Screen type. More...
 
#define SCREEN(S, F, D)   ((uint32_t)((S & 0x0fff) << 16 | (F & 0xff) << 8 | (D & 0xff)))
 Function for screen macros.
 
#define EXTRA(E)   ((uint32_t)((E & 0x0f) << 28))
 Function for extra macros.
 
#define COG(F, Y)   ((uint16_t)((F & 0xff) << 8 | (Y & 0xff)))
 Function for COG macros.
 
Touch events
Note
Numbers are sequential and exclusive
#define TOUCH_EVENT_NONE   0
 No touch event.
 
#define TOUCH_EVENT_PRESS   1
 Touch press event.
 
#define TOUCH_EVENT_RELEASE   2
 Touch release event.
 
#define TOUCH_EVENT_MOVE   3
 Touch move event.
 
Results
Note
Numbers are sequential and exclusive
#define RESULT_SUCCESS   0
 Success.
 
#define RESULT_ERROR   1
 Error.
 
Orientation constants
Note
Numbers are sequential and exclusive
#define ORIENTATION_PORTRAIT   6
 Portrait or vertical, higher than large.
 
#define ORIENTATION_LANDSCAPE   7
 Landscape or horizontal, larger than high.
 
Functions for features from screen macros
#define SCREEN_SIZE(X)   ((uint16_t)((X >> 16) & 0x0fff))
 Get size.
 
#define SCREEN_FILM(X)   ((uint8_t)((X >> 8) & 0xff))
 Get family.
 
#define SCREEN_DRIVER(X)   ((uint8_t)(X & 0xff))
 Get type.
 
#define SCREEN_EXTRA(X)   ((uint8_t)((X >> 28) & 0x0f))
 Get extra.
 
#define COG_FILM(X)   ((uint8_t)((X >> 8) & 0xff))
 Get film.
 
#define COG_FAMILY(X)   ((uint8_t)(X & 0xff))
 Get family.
 
Size, mask 0x0fff = 0..4095
#define SIZE_NONE   0x00
 Unknown.
 
#define SIZE_150   150
 1.50"
 
#define SIZE_152   152
 1.52"
 
#define SIZE_154   154
 1.54"
 
#define SIZE_206   206
 2.06"
 
#define SIZE_213   213
 2.13"
 
#define SIZE_215   215
 2.15"
 
#define SIZE_266   266
 2.66"
 
#define SIZE_271   271
 2.71"
 
#define SIZE_287   287
 2.87"
 
#define SIZE_290   290
 2.90"
 
#define SIZE_340   340
 3.40"
 
#define SIZE_343   343
 3.43"
 
#define SIZE_350   350
 3.50"
 
#define SIZE_370   370
 3.70"
 
#define SIZE_417   417
 4.17"
 
#define SIZE_437   437
 4.37"
 
#define SIZE_565   565
 5.65"
 
#define SIZE_581   581
 5.81"
 
#define SIZE_741   741
 7.41"
 
#define SIZE_969   969
 9.69"
 
#define SIZE_B98   1198
 11.98"
 
#define SIZE_1198   1198
 11.98", synonym for SIZE_B98
 
Film type, mask 0xff
#define FILM_NONE   0x00
 Unknown.
 
#define FILM_C   'C'
 Film C, Standard.
 
#define FILM_E   'E'
 Film E, BWR, deprecated.
 
#define FILM_F   'F'
 Film E, BWR, deprecated.
 
#define FILM_G   'G'
 Film G, BWY, deprecated.
 
#define FILM_H   'H'
 Film H, Freezer.
 
#define FILM_J   'J'
 Film J, BWR, "Spectra".
 
#define FILM_K   'K'
 Film K, Wide temperature and embedded fast update.
 
#define FILM_P   'P'
 Film P, Embedded fast update.
 
#define FILM_Q   'Q'
 Film Q, BWRY, "Spectra 4".
 
#define FILM_T   'T'
 Film T, proxy for P or K with touch.
 
Driver type, mask 0xff
#define DRIVER_NONE   0x00
 Unknown.
 
#define DRIVER_5   '5'
 Driver 5.
 
#define DRIVER_6   '6'
 Driver 6.
 
#define DRIVER_8   '8'
 Driver 8.
 
#define DRIVER_9   '9'
 Driver 9.
 
#define DRIVER_A   'A'
 Driver A.
 
#define DRIVER_B   'B'
 Driver B.
 
#define DRIVER_C   'C'
 Driver C.
 
#define DRIVER_D   'D'
 Driver D.
 
#define DRIVER_E   'E'
 Driver E.
 
#define DRIVER_F   'F'
 Driver F.
 
#define DRIVER_G   'G'
 Driver G.
 
#define DRIVER_H   'H'
 Driver H.
 
#define DRIVER_J   'J'
 Driver J.
 
Extra, mask 0x0f = 0..15
#define EXTRA_TOUCH   1
 Touch.
 
#define EXTRA_DEMO   2
 Demo.
 
Screens families
Note
Numbers are sequential and exclusive
#define FAMILY_SMALL   0x01
 Small screens.
 
#define FAMILY_MEDIUM   0x02
 Medium-sized screens.
 
#define FAMILY_LARGE   0x03
 Large screens with two controllers.
 
List of COG variants
Note
Numbers are sequential and exclusive
#define COG_NONE   0x0000
 Unknown.
 
#define COG_NORMAL_LARGE   COG(FILM_C, FAMILY_LARGE)
 Large screens with normal update, C or J or H film.
 
#define COG_NORMAL_MEDIUM   COG(FILM_C, FAMILY_MEDIUM)
 Medium screens with normal update, C or J or H film.
 
#define COG_NORMAL_SMALL   COG(FILM_C, FAMILY_SMALL)
 Small screens with normal update, C or J or H film.
 
#define COG_FAST_LARGE   COG(FILM_P, FAMILY_LARGE)
 Medium screens with embedded fast update, P film.
 
#define COG_FAST_MEDIUM   COG(FILM_P, FAMILY_MEDIUM)
 Large screens with embedded fast update, P film.
 
#define COG_FAST_SMALL   COG(FILM_P, FAMILY_SMALL)
 Small screens with embedded fast update, P film.
 
#define COG_BWRY_LARGE   COG(FILM_Q, FAMILY_LARGE)
 Large screens with BWRY colours, Q film.
 
#define COG_BWRY_MEDIUM   COG(FILM_Q, FAMILY_MEDIUM)
 Medium screens with BWRY colours, Q film.
 
#define COG_BWRY_SMALL   COG(FILM_Q, FAMILY_SMALL)
 Small screens with BWRY colours, Q film.
 
#define COG_WIDE_LARGE   COG(FILM_K, FAMILY_LARGE)
 Large screens with wide temperature and embedded fast update, K film.
 
#define COG_WIDE_MEDIUM   COG(FILM_K, FAMILY_MEDIUM)
 Medium screens with wide temperature and embedded fast update, K film.
 
#define COG_WIDE_SMALL   COG(FILM_K, FAMILY_SMALL)
 Small screens with wide temperature and embedded fast update, K film.
 
#define COG_TOUCH_SMALL   COG(FILM_T, FAMILY_SMALL)
 Small screens with wide temperature and embedded fast update, T film.
 
Large screens sub-panels selection
Note
Numbers are sequential and exclusive
#define PANEL_CS_MASTER   0x01
 Large screens sub-panels: first panel only.
 
#define PANEL_CS_SLAVE   0x02
 Large screens sub-panels: second panel only.
 
#define PANEL_CS_BOTH   0x03
 Large screens sub-panels: both panels.
 
#define PANEL_CS_MASTER   0x01
 Large screens sub-panels: first panel only.
 
#define PANEL_CS_SLAVE   0x02
 Large screens sub-panels: second panel only.
 
#define PANEL_CS_BOTH   0x03
 Large screens sub-panels: both panels.
 
Scopes for power profile
Note
Numbers are sequential and exclusive
#define POWER_SCOPE_NONE   0x00
 Nothing suspended.
 
#define POWER_SCOPE_GPIO_ONLY   0x01
 GPIO only and if panelPower defined.
 
#define POWER_SCOPE_BUS_GPIO   0x11
 Both bus and GPIO suspended.
 
Modes for power profile
Note
Numbers are sequential and exclusive
#define POWER_MODE_MANUAL   0x00
 Managed by the application code.
 
#define POWER_MODE_AUTO   0x01
 Managed by the screen library.
 
Power and GPIO state
Note
Numbers are sequential and exclusive, except MASK
#define FSM_OFF   0x00
 Bus off, GPIO off or undefined.
 
#define FSM_ON   0x11
 Bus on, GPIO on or defined.
 
#define FSM_SLEEP   0x10
 Bus on, GPIO and Power off or undefined.
 
#define FSM_GPIO_MASK   0x01
 Mask for GPIO on or defined.
 
#define FSM_BUS_MASK   0x10
 Mask for bus on.
 
Update mode
Note
Numbers are sequential and exclusive
Deprecated:

Partial update is removed. Use fast update instead (7.0.0)

GLOBAL_UPDATE is removed. Use UPDATE_NORMAL instead (9.0.0)

#define UPDATE_NONE   0x00
 No update.
 
#define UPDATE_NORMAL   0x01
 Normal update, default.
 
#define UPDATE_FAST   0x02
 Fast update.
 
#define UPDATE_PARTIAL   0x03
 Partial update, deprecated.
 
Frame-buffer sizes
  • Black-white-red screens and monochrome screens
    Frame-buffer size = width * height / 8 * depth, uint32_t
    Depth = 2
  • Black-white-red-yellow screens
    Frame-buffer size = width * height / 4 * depth, uint32_t
    Depth = 1
#define frameSize_EPD_150   (uint32_t)(10000)
 reference 150-xS-0x
 
#define frameSize_EPD_152   (uint32_t)(10000)
 reference 152-xS-0x
 
#define frameSize_EPD_154   (uint32_t)(5776)
 reference 154-xS-0x
 
#define frameSize_EPD_206   (uint32_t)(7936)
 reference 206-xS-0x
 
#define frameSize_EPD_213   (uint32_t)(5512)
 reference 213-xS-0x
 
#define frameSize_EPD_266   (uint32_t)(11248)
 reference 266-xS-0x
 
#define frameSize_EPD_270   (uint32_t)(11616)
 reference 271-xS-0x, legacy name
 
#define frameSize_EPD_271   (uint32_t)(11616)
 reference 271-xS-0x
 
#define frameSize_EPD_287   (uint32_t)(9472)
 reference 287-xS-0x
 
#define frameSize_EPD_290   (uint32_t)(16128)
 reference 290-xS-0x
 
#define frameSize_EPD_340   (uint32_t)(22344)
 reference 340-xS-0x
 
#define frameSize_EPD_343   (uint32_t)(22344)
 reference 343-xS-0x, legacy name
 
#define frameSize_EPD_350   (uint32_t)(24960)
 reference 350-xS-0x
 
#define frameSize_EPD_370   (uint32_t)(24960)
 reference 370-xS-0x
 
#define frameSize_EPD_417   (uint32_t)(30000)
 reference 417-xS-0x
 
#define frameSize_EPD_437   (uint32_t)(21120)
 reference 437-xS-0x
 
#define frameSize_EPD_565   (uint32_t)(33600)
 reference 565-xS-0x
 
#define frameSize_EPD_581   (uint32_t)(46080)
 reference 581-xS-0x
 
#define frameSize_EPD_741   (uint32_t)(96000)
 reference 741-xS-0x
 
#define frameSize_EPD_969   (uint32_t)(161280)
 reference 969-xS-0x
 
#define frameSize_EPD_B98   (uint32_t)(184320)
 reference xE21198xS0xx
 

Detailed Description

List of constants for Pervasive Displays Library Suite.

Project Pervasive Displays Library Suite
Based on highView technology

Date
21 Jan 2025
Version
902
Copyright
(c) Pervasive Displays Inc., 2021-2025
(c) Etigues, 2010-2025
All rights reserved
For exclusive use with Pervasive Displays screens
  • Basic edition: for hobbyists and for basic usage
    Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
    See also
    https://creativecommons.org/licenses/by-sa/4.0/

    Consider the Evaluation or Commercial editions for professionals or organisations and for commercial usage
  • Evaluation edition: for professionals or organisations, evaluation only, no commercial usage
    All rights reserved
  • Commercial edition: for professionals or organisations, commercial usage
    All rights reserved
  • Viewer edition: for professionals or organisations
    All rights reserved
  • Documentation
    All rights reserved

Macro Definition Documentation

◆ eScreen_EPD_t

#define eScreen_EPD_t   uint32_t

Screen type.

Deprecated:
Screen name format (8.0.0)
  • Name format eScreen_EPD_EXT3_<size>_<driver>_<suffix> is deprecated (8.0.0)
  • Use name format eScreen_EPD_<size>_<film>_<driver> instead (8.0.0)