Skip to main content

E Ink application usage

How does it work?​

The E Ink 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 E Ink 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 E Ink application on your device automatically with Wallboard Toolbox or manually using our guides (Philips, Sharp).

First time usage​

When the E Ink 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.

info

After assigning and setting up the E Ink device it might seem to be stuck on the screen with the activation code, however this is normal. Wait for 2 minutes until it wakes up and re-checks everything on the server.

Displaying content on the E Ink screen​

There are 3 ways of using E Ink devices.

Using regular content​

You can display content onto E Ink devices by simply assigning content to the screen. You can do so by right clicking the device then going to Content >> Assign content or by dragging and dropping the content onto the screen. To learn more about contents click here.

Info

To add a wait time before the snapshot of the content is created use advanced configuration parameters (right click on content > Advanced Configuration). Note that wait times could vary because of content loading times.

Wait time(ms) advanced configuration: {"configuration": [{"type": "SCREENSHOT", "waitTime": 3000}]}

Using loops​

Loops can be used to display pictures on the E Ink devices. Simply drag the loop you want to use onto the device. When creating loops for the E Ink devices do not use layouts, use only full screen images that are matching the resolution of the E Ink screen, if the picture resolution is lower or higher than the E Ink screen's resolution then the application will upscale or downscale the image. To learn more about loops click here.

Using datasource binding​

You can create external or system screenshot datasources that you can use to bind to an E Ink 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 onto an E Ink device create a screenshot datasource first then navigate to the editor's home screen and right click on the screen, go to Manage screen >> Device properties >> Set datasource binding and select the screenshot type datasource you created. To learn more about screenshot datasources click here.

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.

caution

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

Important

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

Important

The E Ink application does not support .webp images currently.

Updating the E Ink application​

The E Ink application can only be updated automatically after an update rule is set up with the device Update management.
More information about the device Update management can be found here .

Synchronization configuration​

Choose a method:

{
	"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).
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