Web Page - URL Parameters Per Device

Web Page - URL Parameters Per Device

Introduction

Web Pages provide a single URL address that is used throughout Yodeck. In case you wanted to display different content depending on the device (Monitor), then you would have to use a different Web Page entry for each Monitor, creating also a different Show and Schedule.

To avoid this, we provide two unique parameters that can be used in the Web Page URL address. These parameters are replaced in the URL you provide with the respective values for each Monitor. Your web page should then be able to differentiate the behavior, based on this ID. Here are the value we currently support:
  • DEVICE_ID  -  This is the ID displayed in the Monitors listing, e.g. 4321
  • DEVICE_UUID  -  This is the ID displayed in the Monitor's details, e.g. abcdef112abcdef112abcdef112
  • DEVICE_NAME  -  This is the Name of the Monitor, e.g. "Lobby Screen"
Please note the following:
  • All occurrences of these special names in all URL addresses will be replaced.
  • These parameter names are case sensitive, so they must be used in uppercase. If not in uppercase, they won't be replaced.
  • The "DEVICE_NAME" values are URL-encoded, so you can use any character you want, including non-Latin characters.
  • Currently, there is no way to specify a value for DEVICE_ID and DEVICE_UUID. If you delete a Monitor (device) from your account, the DEVICE_UUID and DEVICE_ID values are lost and you can't retrieve them or re-create the device entry with these values. Check out the "Using a Custom ID" section below.

Using a Custom ID

In case you want to use a Custom ID for each Monitor, you can do that by using the "DEVICE_NAME" parameter, but with a twist to make it easier. If the name of a Monitor includes the special character "~" (called "tilde"), then only the part after tilde is used while replacing. So, if you specify "Lobby Screen ~653" as a Name for a Monitor, then the DEVICE_NAME parameter will use only the "653" value.

This way, you can specify a Custom ID of your own within the Name of each Monitor, so that management of the custom URLs is easier.

Examples

Let's say you have 2 Monitors with Device IDs 4001 and 4002. If you use the following URL in a Web Page:


the following URLs will be sent respectively to each of the two devices:


Let's say you have 3 Monitors with Device Names "Lobby Screen", "Reception Screen" and "Arena Screen ~1234". If you use the following URL in a Web Page:


the following URLs will be sent respectively to each of the two devices:

To device "Reception Screen":  https://httpbin.org/get?q=Reception%20Screen&argument=value
To device " Arena Screen ~1234":  https://httpbin.org/get?q=1234&argument=value  

    • Related Articles

    • Web Pages List

      In the "Web Pages" section, you can add and manage Web Pages that can be opened on Yodeck monitors. Web Pages are always loaded dynamically on monitors, so no uploading or downloading happens. Just like if you opened a browser window! The Web ...
    • Does Yodeck support authenticating on a web page?

      A website may require authentication to access a specific URL. Usually, authentication is implemented using two different ways: HTTP Basic Authentication Form-based Authentication, using sessions (cookies) HTTP Basic Authentication If the ...
    • Setting a Web Page to refresh

      When you add a single Web Page to a Show, the Web Page will not refresh. The same thing happens with a Playlist with a single Web Page in it. This is by design, since many Web Pages need to be shown constantly. To refresh a Web Page, you must create ...
    • Grafana

      Any dashboard of your choice, including Grafana dashboards, can be displayed on the TV screen. The Yodeck player can display any web-page or dashboard out there.  Reach out to our support by clicking the ? icon on your personal Yodeck account (it is ...
    • How many monitors does Yodeck support per account?

      You can have as many monitors as you need! Yodeck uses scalable technologies that can support tens of thousands of monitors under a single Yodeck account. Really!