| Line 1: |
| - |
[[Image:esl_server_sw_dashboard.png|franeless|right|400px|]]
|
+ |
{| class="wikitable" cellpadding="30"
|
| - |
=Overview=
|
+ |
|-
|
| |
|
+ |
|__TOC__
|
| |
|
+ |
|[[Image:esl_server_sw_dashboard.png|frameless|right|500px|]]
|
| |
|
+ |
|[[Image:esl_tags_panel.png|frameless|right|600px|]]
|
| |
|
+ |
|}
|
| |
|
|
|
| |
==First Steps== |
|
==First Steps== |
| |
{| class="wikitable" cellpadding="30" |
|
{| class="wikitable" cellpadding="30" |
| Line 56: |
| |
|- |
|
|- |
| |
|<h3>Reactivation Process</h3> |
|
|<h3>Reactivation Process</h3> |
| |
|
+ |
{| class="wikitable" cellpadding="30"
|
| |
|
+ |
|Hover your mouse over the ESL tab and click on Reactivate ESL's.
|
| |
|
+ |
|[[Image:reactivate_esl_tags.png|400px|]]
|
| |
|
+ |
|-
|
| |
|
+ |
|Place the ESL tags nearby the connected Base Station.<br>
|
| |
|
+ |
#Select the Base Station and variant.
|
| |
|
+ |
#Supply the address range and press ‘Start’.
|
| |
|[[Image:reactivation_screen.png|400px|]] |
|
|[[Image:reactivation_screen.png|400px|]] |
| - |
|To reactivate these ESLs place them nearby the connected Base Station and go to<strong> ESLs > Reactivate ESLs </strong> <br>Select the Base Station and variant, supply the address range and press ‘Start’
|
|
|
| |
|} |
|
|} |
| |
|
+ |
<br>
|
| - |
After pressing this button, the number of ESLs that have been reactivated so far will be shown. Since the ESLs will only wake-up for a split second every few minutes, it can take more than 15 minutes before all
|
+ |
After pressing Start, the number of ESLs that have been reactivated so far will be shown.
|
| - |
ESLs have been successfully reactivated. You can verify this by checking whether the ‘DEACTIVATED’ message has disappeared from the screen.
|
+ |
<br><br>
|
| |
|
+ |
<strong>Since the ESLs will only wake-up for a split second every few minutes, it can take more than 15 minutes before all
|
| |
|
+ |
ESLs have been successfully reactivated.
|
| |
|
+ |
<br>You can verify this by checking whether the ‘DEACTIVATED’ message has disappeared from the screen. </strong>
|
| |
|
+ |
<br><br>
|
| |
Active ESLs will be periodically search for a Base Station, so as soon as a Base Station is within range, they will |
|
Active ESLs will be periodically search for a Base Station, so as soon as a Base Station is within range, they will |
| - |
associate with it and start sending data requests and status information to it.
|
+ |
associate with it and start sending data requests and status information to it.
|
| |
|
+ |
<br><br>
|
| |
When a Base Station is turned off or an ESL is moved out of range, an ESL will time out after a couple of minutes and starts seeking for another Base Station |
|
When a Base Station is turned off or an ESL is moved out of range, an ESL will time out after a couple of minutes and starts seeking for another Base Station |
| - |
in range.
|
+ |
in range.<br>
|
| |
<i>See chapter 6.1.3 Action dropdown for more information about configuring ESLs.</i> |
|
<i>See chapter 6.1.3 Action dropdown for more information about configuring ESLs.</i> |
| - |
<br>
|
+ |
<br><br>
|
| |
|
|
|
| |
It might be possible that even though the ESLs are working properly, they still don’t connect to the Base Station. |
|
It might be possible that even though the ESLs are working properly, they still don’t connect to the Base Station. |
| |
This might be caused by strong interference on the default RF-channel of the Base Station. |
|
This might be caused by strong interference on the default RF-channel of the Base Station. |
| - |
<i>To resolve this problem, see chapter 5.4 Energy scan.</i>
|
+ |
<br><i>To resolve this problem, see chapter 5.4 Energy scan.</i>
|
| |
|
|
|
| |
=Dashboard= |
|
=Dashboard= |
| |
|
+ |
{| class="wikitable" cellpadding="50"
|
| - |
[[Image:dashboard_4.png|600px|]]
|
+ |
|The dashboard is the main page of the ESL Web Server, which gives you a quick impression on the status of the ESL
|
| - |
<br>
|
|
|
| - |
The dashboard is the main page of the ESL Web Server, which gives you a quick impression on the status of the ESL
|
|
|
| |
system. |
|
system. |
| |
<br> |
|
<br> |
| Line 88: |
| |
====<span style="color:red"> If there’s an error, then a tile turns RED.</span>==== |
|
====<span style="color:red"> If there’s an error, then a tile turns RED.</span>==== |
| |
|
|
|
| |
|
|
|
| |
In total there are 4 groups that can change status: ESLs, Base Stations, Database and Links. |
|
In total there are 4 groups that can change status: ESLs, Base Stations, Database and Links. |
| - |
===ESL===
|
+ |
|[[Image:dashboard_4.png|frameless|center|800px]]
|
| - |
When pressing on the ESL tile, the dashboard will expand show 4 pie charts with different status information:
|
+ |
|}
|
| |
|
|
|
| - |
[[Image:dashboard_8.png|600px|]]
|
+ |
::<h2>ESL</h2>
|
| - |
====Link status====Shows how many ESLs have been linked and how many active ESLs are not linked.
|
+ |
:::When pressing on the ESL tile, the dashboard will expand show 4 pie charts with different status information:
|
| |
|
|
|
| - |
====Connection status====Shows the connection status of all ESLs that have been linked, which can be good, poor and
|
+ |
:::[[Image:dashboard_8.png|600px|]]
|
| - |
disconnected.
|
+ |
::::<h5>Link status</h5> Shows how many ESLs have been linked and how many active ESLs are not linked.<br>
|
| |
|
|
|
| - |
====Image status====Shows how many ESLs are showing the latest image, how many are still busy updating the image and
|
+ |
::::<h5>Connection status</h5>Shows the connection status of all ESLs that have been linked, which can be good, poor and disconnected.<br>
|
| - |
how many failed to update (i.e. due to being disconnected or due to a hardware failure).
|
|
|
| - |
====Battery status====Shows the battery status of the linked ESLs, which can be OK, low, or empty/disconnected.
|
+ |
::::<h5>Image status</h5>Shows how many ESLs are showing the latest image, how many are still busy updating the image and how many failed to update (i.e. due to being disconnected or due to a hardware failure).<br>
|
| - |
=== Base stations===
|
|
|
| - |
The Base Station tile shows whether or not all Base Station are connected. When pressing on the Base Station tile it
|
+ |
::::<h5>Battery status</h5>Shows the battery status of the linked ESL's:<br>
|
| - |
shows the amount of connected Base Stations, which can then be viewed by clicking on it.
|
+ |
:::::<span style="color:green"> OK</span>
|
| - |
===Database===
|
+ |
::::: <span style="color:orange"> LOW</span>
|
| - |
The database tile shows whether your database is currently connected, how many products are present in the
|
+ |
::::: <span style="color:red"> EMPTY / DISCONNECTED.</span><br><br>
|
| - |
product table and when the next synchronization will take place.
|
|
|
| - |
===Link===
|
+ |
::<h2>Base stations</h2>
|
| - |
The link tile shows how many links are present in the link table, which can be viewed by clicking on it. It also offers a
|
+ |
::The Base Station tile shows whether or not all Base Station are connected. When pressing on the Base Station tile it shows the amount of connected Base Stations, which can then be viewed by clicking on it.<br><br>
|
| - |
shortcut to the Quick Link tool (see chapter 7.2 Quick Link for more information).
|
|
|
| - |
===Dashboard settings===
|
+ |
::<h2>Database</h2>
|
| - |
Dashboard settings can be found under ‘Advanced > Dashboard settings’ (default
|
+ |
::The database tile shows whether your database is currently connected, how many products are present in the product table and when the next synchronization will take place.<br><br>
|
| - |
https://ebs50.local/advanced/dashboardsettings)
|
|
|
| - |
When there is an issue with your ESLs, these are grouped into errors and warnings. Examples of errors are linked
|
+ |
::<h2>Link</h2>
|
| - |
ESLs that are not online anymore, or ESLs that failed to update their image. Examples of warnings are ESLs that have
|
+ |
::The link tile shows how many links are present in the link table, which can be viewed by clicking on it. It also offers a shortcut to the Quick Link tool (see chapter 7.2 Quick Link for more information).
|
| - |
a bad wireless connection, or ESLs that are low on batteries.
|
|
|
| |
|
+ |
==Dashboard settings==
|
| |
|
+ |
{| class="wikitable" cellpadding="30"
|
| |
|
+ |
|-
|
| |
|
+ |
|Dashboard settings can be found under <strong> ‘Advanced > Dashboard settings’ </strong>
|
| |
|
|
|
| |
|
+ |
When there is an issue with your ESLs, these are grouped into <span style="color:red">errors </span> and <span style="color:orange">warnings</span>.
|
| |
|
|
|
| |
|
+ |
*<span style="color:red">Examples of errors:</span>
|
| |
|
+ |
**<span style="color:red">Linked ESL's that are not online anymore.</span>
|
| |
|
+ |
**<span style="color:red">ESL's that failed to update their image.</span>
|
| |
|
+ |
<br>
|
| |
|
+ |
*<span style="color:orange">Examples of warnings:</span>
|
| |
|
+ |
**<span style="color:orange">ESL's with bad wireless connections.</span>
|
| |
|
+ |
**<span style="color:orange">ESL's with low batteries.</span>
|
| |
|
+ |
<br>
|
| |
If you have 100 ESLs, you may want to be warned immediately if even a single ESL is showing an error. If you have |
|
If you have 100 ESLs, you may want to be warned immediately if even a single ESL is showing an error. If you have |
| |
1500 ESLs, you may be okay with a dozen ESLs giving an issue before spending the time on maintenance. |
|
1500 ESLs, you may be okay with a dozen ESLs giving an issue before spending the time on maintenance. |
| |
|
|
|
| |
The ESL status sensitivity screen allows you to set a percentage of ESLs reporting an error and ESLs reporting a |
|
The ESL status sensitivity screen allows you to set a percentage of ESLs reporting an error and ESLs reporting a |
| |
warning that you find acceptable. |
|
warning that you find acceptable. |
| Line 124: |
| |
|
+ |
|[[Image:dashboard_settings.png|frameless|center|300px|]]
|
| |
|
+ |
|}
|
| |
|
|
|
| |
=Finding and Adding Base Stations= |
|
=Finding and Adding Base Stations= |
| |
====EBS-50==== |
|
====EBS-50==== |
| Line 127: |
| |
device. You will not need to take any further steps. |
|
device. You will not need to take any further steps. |
| |
====EBS-40==== |
|
====EBS-40==== |
| - |
The EBS-40 can most easily be found through the discovery function.
|
+ |
The EBS-40 can most easily be found through the discovery function. If you cannot locate it, then it can be manually added using the manual option.
|
| - |
Browse to the ESL Web Server.
|
+ |
<h5>Discovery Function </h5>
|
| |
|
+ |
{| class="wikitable" cellpadding="30"
|
| |
|
+ |
|Click on the Base Stations tab at the top.
|
| |
<ol> |
|
<ol> |
| - |
<li>Choose “Base Stations” from the menu bar at the top and press the button “Search Base Stations”.
|
+ |
<li>Click on “Search Base Stations”. <br>A window will appear that will start to list all of the Base Stations discovered on the network. </li>
|
| - |
A window will appear that will start to list all of the Base Stations discovered on the network. </li>
|
|
|
| |
<li>Click on the button “Add” to add a Base Station to your list.</li> |
|
<li>Click on the button “Add” to add a Base Station to your list.</li> |
| |
</ol> |
|
</ol> |
| |
|
+ |
|[[Image:banner_bs.png|frameless|center|500px|]]
|
| |
|
+ |
|[[Image:basestations_found.png|frameless|center|500px|]]
|
| |
|
+ |
|}
|
| |
|
+ |
<h5>Manual Option</h5>
|
| |
|
+ |
{| class="wikitable" cellpadding="30"
|
| |
|
+ |
|Click on the Base Stations tab at the top.
|
| |
|
+ |
#Click on the button “Manually add Base Station”.
|
| |
|
+ |
#In the pop up window:
|
| |
|
+ |
##Enter the IP address of the Base Station you want to add.
|
| |
|
+ |
##Enter the port number. (<i>default <strong>1002</strong> for the EBS-40</i>)
|
| |
|
+ |
##Select the type of Base Station.
|
| |
|
+ |
#Press “Add” to add this manually added Base Station to the list.
|
| |
|
+ |
|[[Image:banner_bs.png|frameless|center|500px|]]
|
| |
|
+ |
|[[Image:manually_adding_basestations.png|frameless|center|500px|]]
|
| |
|
+ |
|}
|
| |
|
|
|
| - |
<br>
|
|
|
| - |
insert picture
|
|
|
| - |
<br>
|
|
|
| - |
Figure 14: Base Station discovery screen
|
|
|
| - |
If the Base Station cannot be discovered (i.e. if the Base Station is not on the same subnet) you can add the Base
|
|
|
| - |
Station manually. Click on the button “Manually add Base Station”. In the new window you can supply the IP address
|
|
|
| - |
of the Base Station you want to add, its communication port (by default 1002 for the EBS-40) and the type of Base
|
|
|
| - |
Station. Press “Add” to add this manually added Base Station to the list. If the credentials are correct, your Base
|
|
|
| - |
Station should soon switch its value in the column “Status” to “Connected”.
|
|
|
| |
=Energy Scan= |
|
=Energy Scan= |
| |
|
|
|
| |
Energy scanning is a tool that helps you to find out how busy the radio space is. The e-paper ESLs communicate |
|
Energy scanning is a tool that helps you to find out how busy the radio space is. The e-paper ESLs communicate |
| |
wirelessly with the Base Station on the 2.4GHz band, which may also be used by, for instance, Wi-Fi or Bluetooth. |
|
wirelessly with the Base Station on the 2.4GHz band, which may also be used by, for instance, Wi-Fi or Bluetooth. |
| Line 155: |
| |
To change the channel that your Base Station uses, you can edit the settings. |
|
To change the channel that your Base Station uses, you can edit the settings. |
| |
<br><i>See chapter 5.6.1 Channel for more information.</i> |
|
<br><i>See chapter 5.6.1 Channel for more information.</i> |
| |
|
+ |
<br>
|
| |
|
+ |
[[Image:energy_scan.png|frameless|center|500px|]]
|
| |
|
|
|
| |
|
+ |
=REST API=
|
| |
|
+ |
The ESL Web Server software has a REST API that communicates over a set of HTTP endpoints. <br>
|
| |
|
+ |
Using the correct verbs:
|
| |
|
+ |
*<strong>GET</strong> to receive information.
|
| |
|
+ |
* <strong>PUT </strong> for new information.
|
| |
|
+ |
*<strong>POST</strong> for changes to information.
|
| |
|
+ |
*<strong> DELETE </strong> for removal of information.
|
| |
|
+ |
<br><br>
|
| |
|
+ |
This API allows you to manage the ESL Web Server software programmatically without use of the web interface that you would use for manual operation.
|
| |
|
+ |
<br>
|
| |
|
+ |
All of the actions that you can perform on the API and the way you specify that action are listed in the user manual section <i>12.1 REST API</i>.
|
| |
|
|
|
| |
|
+ |
=Linking=
|
| |
|
+ |
{| class="wikitable" cellpadding="30"
|
| |
|
+ |
|-
|
| |
|
+ |
|Linking of ESLs is the process of telling the system which product should be shown on which ESL.
|
| |
|
|
|
| |
|
+ |
This is done by connecting the MAC Address of the ESL tag with the Unique ID in the database.
|
| |
|
+ |
|[[Image:linking_banner.png|frameless|center|500px|]]
|
| |
|
+ |
|-
|
| |
|
+ |
|<br> In a store environment this is usually done by inputting the MAC address bar code on the ESL label followed by inputting the unique ID of the product.
|
| |
|
+ |
<br><br>The unique ID can be anything: an EAN code, article number, location, room number, etc. <br>As long as it’s a unique identifier in the database, it can be linked to an ESL.
|
| |
|
+ |
<br><br>In the field “Unique ID” you can supply a UID, barcode or description.
|
| |
|
+ |
<br><br>
|
| |
|
+ |
<i>You can open a product selector by pressing the pencil and paper icon to the right of the input box.</i>
|
| |
|
+ |
|[[Image:linking_esl_tags.png|frameless|center|500px|]]
|
| |
|
+ |
|[[Image:products_linking.png|frameless|center|500px|]]
|
| |
|
+ |
|}
|
| |
=Documents= |
|
=Documents= |
| |
{| class="wikitable" border="2" style="color:#47888c; text-align: center; background-color:#F1F5F7;" cellpadding="30" |
|
{| class="wikitable" border="2" style="color:#47888c; text-align: center; background-color:#F1F5F7;" cellpadding="30" |
