Skip to main content

ePaper application usage

How does it work?​

The ePaper application differs from our Signage application in a way that it is not always connected to a server, rather it wakes up after sleeping for a set amount of time and re-checks on the server if anything has changed in the assigned content.

  • The amount of sleep time is 2 minutes by default, but it is customizable with the Synchronization Configuration advanced configuration of which more information can be found here.

  • While the ePaper device sleeps, it does not receive updates from the server, which means any content or device settings change will only be applied the next time the device wakes up.

Installation​

You can install the ePaper application on your device automatically with Wallboard Toolbox or manually using our guides

First time usage​

When the ePaper device is first assigned to a server it will display the 4-digit application code and go back to sleep for 2 minutes by default.

  • It will repeat this cycle until it is assigned to a customer on the server and receives its first content.
After assigning and setting up the ePaper device it might seem to be stuck on the screen with the activation code.

This behaviour is normal. Wait for 2 minutes until it wakes up and re-checks everything on the server.

Displaying content on the ePaper screen​

There are 3-ways of using ePaper devices.

Using regular content​

You can display content onto ePaper devices by simply assigning content to the screen.

  • You can do so by entering the device settings then selecting the Assign content option.
  • To learn more about contents click here.
Wait time

To add a wait time before the snapshot of the content is created use advanced configuration parameters in the device settings in the Advanced Configuration field.

  • Note that wait times could vary because of content loading times.

Wait time (ms) advanced configuration:

{
   "configuration":[
      {
         "type":"SCREENSHOT",
         "waitTime":3000
      }
   ]
}

Using playlists​

Playlists can be used to display pictures on the ePaper devices.

  • Enable the ePaper mode on the playlists you want to display on the device, then simply assign the playlists you want to use onto the device.
  • When creating playlists for the ePaper devices, they use only full screen images that are matching the resolution of the ePaper screen, if the picture resolution is lower or higher than the ePaper screen's resolution then the application will upscale or downscale the image.

Learn more: ePaper mode playlists.

Using datasource binding​

You can create external or system screenshot datasources that you can use to bind to an ePaper display.

  • Screenshot type external datasources can be used to take screenshots of a webpage by providing a URL.
  • By creating a screenshot type system datasource you can also create screenshots of content you created in the editor.
  • To display a screenshot on an ePaper devices create a screenshot datasource first then navigate to devices and enter the device settings then find Set datasource binding and select the screenshot type datasource you created.

Learn more: System Screenshot datasources
Learn more: External Screenshot datasources

Important

  • Binding a screenshot datasource has priority over assigning content by other methods so if you assign a content or loop and have a screenshot datasource bound to the screen, only the bound screenshot datasource will appear.

  • Note that ePaper devices can only show static images so any videos or interactive content won't play properly.

  • The ePaper application does not support .webp images currently.

caution

When modifying content keep in mind that changes will only appear after the screenshot datasource and the ePaper display itself has refreshed. This could take several minutes.

Device management​

Updating the ePaper application​

The ePaper application can only be updated automatically after an update rule is set up with the device Update management.

Learn more:Update management.

Wake-up time configuration​

Configuration with Page duration​

Use the Settings > Device and Page duration (seconds) to set-up wake-up time.

  • This method fills out advanced configuration with fixed time automatically.

Configuration with fixed time​

Use the Settings >> Advanced configuration to set-up wake-up time.

{
	"configuration": [
		{
			"type": "CONFIG_SYNCHRONIZATION",
			"syncPeriodMillis": 86400000
		}
	]
}
  • syncPeriodMillis specifies how long the device will sleep in milliseconds. In this case it is set to 86400000 (1 day).

Configuration with cron expression​

Use the Settings >> Advanced configuration to set-up wake-up time.

{
	"configuration": [
		{
			"type": "CONFIG_SYNCHRONIZATION",
			"syncPeriodCron": "0 0 12 ? * * *"
		}
	]
}
  • syncPeriodCron specifies a cron expression which tells the device when to wake up. In this case it is set to 12:00:00 am every day.

If you want to use a different time period use a cron expression generator to get the desired value.

The device will change Content and Playlist pages at every wake-up.

caution

Do not use both syncPeriodMillis and syncPeriodCron in the same configuration, if both are used then the syncPeriodCron parameter will be used by the application.

Last updated on