2.1.3 • Published 2 years ago

@epaperjs/cli v2.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@epaperjs/cli

Command line interface for displaying a URL on an ePaper display on a Raspberry Pi

Usage

ejs <command> [options] <deviceType>

For example, the following command will update the Waveshare 7.5" v2 screen with the contents of http://localhost:8080 every 10 minutes.

ejs refresh rpi-7in5-v2 "http://localhost:8080"

For available devices types, see supported hardware. The different commands and suggested workflows are described below.

Commands

Display: display a single rendition of a URL

ejs display [options] <deviceType> <url>
OptionDescriptionAllowed Values
-o / --orientationUse (h)orizontal or (v)ertical orientation[h, v]
-c / --colorModeDesired color mode[black, 4gray, red]
--screenshotDelayWait an additional amount of time after loading the URL before displaying. Useful for client side appsTime in milliseconds
--ditherUse a dithering algorithm to approximate grayscale / mid-tones on black and white displays
--usernameUsername for basic authenticationusername as string
--passwordPassword for basic authenticationpassword as string
--debugPrint additional log info and stacktraces
--versionShow version number
--helpShow help

Refresh: continuously update and display the URL

ejs refresh [options] <deviceType> <url>
OptionDescriptionAllowed Values
-i / --intervalAmount of time between refreshesTime in seconds (default 10 min)
-o / --orientationUse (h)orizontal or (v)ertical orientation[h, v]
-c / --colorModeDesired color mode[black, 4gray, red]
--screenshotDelayWait an additional amount of time after loading the URL before displaying. Useful for client side appsTime in milliseconds
--ditherUse a dithering algorithm to approximate grayscale / mid-tones on black and white displays
--usernameUsername for basic authenticationusername as string
--passwordPassword for basic authenticationpassword as string
--debugPrint additional log info and stacktraces
--versionShow version number
--helpShow help

Clear: clear the display

ejs clear [options] <deviceType>
OptionDescriptionAllowed Values
--debugPrint additional log info and stacktraces
--versionShow version number
--helpShow help

Workflows

Self-Hosting

  • Create a web app and store it on your Raspberry Pi
  • Host the web app with http-server
  • Run ePaper.js with ejs refresh <deviceType> "http://localhost:8080" (or whatever port you configure http-server to run on)

Cloud Hosting

  • Create a web app and host it on a service like GitHub Pages or Netlify
  • Run ePaper.js with ejs refresh <deviceType> "<URL of your app>"

Running As a Daemon \ There are several methods of automatically launching ePaper.js on startup and restarting in case of failures

Installation

npm i -g @epaperjs/cli
2.1.2

2 years ago

2.1.3

2 years ago

2.1.1

2 years ago

2.1.0

2 years ago

2.0.3

2 years ago

2.0.2

2 years ago

2.0.1

2 years ago

2.0.0

2 years ago

2.0.0-next.3

2 years ago